PHPackages esimonetti/toothpaste - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [CLI & Console](/categories/cli) 4. / 5. esimonetti/toothpaste ActivePackage[CLI & Console](/categories/cli) esimonetti/toothpaste ===================== CLI utility to analyse, optimise and provide additional functionality to your Sugar system 0.2.4(3y ago)111.0k18[1 PRs](https://github.com/esimonetti/toothpaste/pulls)Apache-2.0PHPPHP >=7.1 Since Oct 28Pushed 3y ago4 watchersCompare [ Source](https://github.com/esimonetti/toothpaste)[ Packagist](https://packagist.org/packages/esimonetti/toothpaste)[ RSS](/packages/esimonetti-toothpaste/feed)WikiDiscussions master Synced 2w ago READMEChangelog (9)Dependencies (3)Versions (21)Used By (0) Toothpaste ========== [](#toothpaste) *This tool is provided AS-IS and might have bugs. Please help create and provide bug fixes!* Donations --------- [](#donations) If you find this software useful, please consider supporting the work that went into it, with a monthly amount. Thank you! [![](https://camo.githubusercontent.com/bd37932c920736cc97c5aa0740def0b4a54adbb7ec556223f6d3af90d7a1ed53/68747470733a2f2f7777772e70617970616c6f626a656374732e636f6d2f656e5f41552f692f62746e2f62746e5f646f6e6174655f4c472e676966)](https://www.paypal.com/donate/?business=35FG9B3LQ3WPA&no_recurring=0&item_name=If+you+find+this+software+useful%2C+please+consider+supporting+the+work+that+went+into+it%2C+with+a+monthly+amount.+Thank+you%21¤cy_code=AUD) Description ----------- [](#description) CLI utility to analyse, optimise and provide additional functionality to your Sugar system. As it is a CLI only tool, it cannot execute from within Sugar Cloud. This tool allows the execution of various CLI actions including repair, useful ongoing maintenance, identification of possible problems and extracting data from a Sugar installation. Requirements ------------ [](#requirements) - Linux or Macintosh - PHP >= 7.1 - Composer - Some commands only run with MySQL at this stage Installation ------------ [](#installation) Within your installation directory (eg: `~/toothpaste`), run the following: ``` composer require esimonetti/toothpaste dev-master ``` Composer will download toothpaste and all its dependencies, so that you are ready to go. To be able to execute local commands, toothpaste has to be able to access a local Sugar installation, be on the same server, and with php CLI available. ### Installation on SugarDockerized [](#installation-on-sugardockerized) As there were some problems running the installation commands from outside the containers, the following installation steps will enter the `sugar-cron` container to perform the installation. ``` docker exec -it sugar-cron bash mkdir ../toothpaste cd ../toothpaste composer require esimonetti/toothpaste dev-master exit ``` ### Running toothpaste on SugarDockerized [](#running-toothpaste-on-sugardockerized) To execute toothpaste, leverage the bash scripts provided with SugarDockerized ``` ./utilities/runcli.sh "cd ../toothpaste && ./vendor/bin/toothpaste list" ``` Sample uses ----------- [](#sample-uses) ### List [](#list) To show the list of commands available, run the following: ``` ./vendor/bin/toothpaste list ``` ### Repair [](#repair) To repair a system (located in `/var/www/html/sugar`), run the following: ``` ./vendor/bin/toothpaste local:system:repair --instance /var/www/html/sugar ``` ``` Toothpaste vX.X.X Executing Repair command... Entering /var/www/html/sugar... Setting up instance... Executing simple repair... Clearing cache... Executing basic instance warm-up... Execution completed in 6.01 seconds. ``` ### Maintenance on/off [](#maintenance-onoff) To set maintenance mode on/off for a system (located in `/var/www/html/sugar`), run the following: ``` ./vendor/bin/toothpaste local:maintenance:on --instance /var/www/html/sugar ``` ``` Toothpaste vX.X.X Setting maintenance mode on... Entering /var/www/html/sugar... Setting up instance... The configuration setting maintenanceMode is now set to: on The system is ONLY accessible via the UI by ADMINISTRATOR users Execution completed in 0.19 seconds. ``` ``` ./vendor/bin/toothpaste local:maintenance:off --instance /var/www/html/sugar ``` ``` Toothpaste vX.X.X Setting maintenance mode off... Entering /var/www/html/sugar... Setting up instance... The configuration setting maintenanceMode is now set to: off The system is accessible via the UI by all users Execution completed in 0.17 seconds. ``` ### Health Score 31 — LowBetter than 66% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity25 Limited adoption so far Community17 Small or concentrated contributor base Maturity52 Maturing project, gaining track record Bus Factor1 Top contributor holds 93% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~62 days Recently: every ~268 days Total 20 Last Release 1247d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/1671865?v=4)[Enrico Simonetti](/maintainers/esimonetti)[@esimonetti](https://github.com/esimonetti) --- Top Contributors [![esimonetti](https://avatars.githubusercontent.com/u/1671865?v=4)](https://github.com/esimonetti "esimonetti (40 commits)")[![R3dian](https://avatars.githubusercontent.com/u/6056892?v=4)](https://github.com/R3dian "R3dian (2 commits)")[![GarciaSiego](https://avatars.githubusercontent.com/u/18658774?v=4)](https://github.com/GarciaSiego "GarciaSiego (1 commits)") ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/esimonetti-toothpaste/health.svg) ``` [![Health](https://phpackages.com/badges/esimonetti-toothpaste/health.svg)](https://phpackages.com/packages/esimonetti-toothpaste) ``` ### Alternatives [drupal/core Drupal is an open source content management platform powering millions of websites and applications. 19664.8M1.6k](/packages/drupal-core)[whatsdiff/whatsdiff See what's changed in your project's dependencies 771.1k](/packages/whatsdiff-whatsdiff)[eliashaeussler/cache-warmup Composer package to warm up website caches, based on a given XML sitemap 75419.2k9](/packages/eliashaeussler-cache-warmup)[open-dxp/opendxp Content & Product Management Framework (CMS/PIM) 9417.2k58](/packages/open-dxp-opendxp)[aeliot/todo-registrar Register TODOs from source code in issue tracker 153.0k](/packages/aeliot-todo-registrar)[aedart/athenaeum Athenaeum is a mono repository; a collection of various PHP packages 245.2k](/packages/aedart-athenaeum) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)