PHPackages inetprocess/sugarcli - 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. inetprocess/sugarcli ActiveLibrary[CLI & Console](/categories/cli) inetprocess/sugarcli ==================== SugarCli is a command line tool to install and manage SugarCRM installations. v1.25.8(1y ago)3615712[2 PRs](https://github.com/inetprocess/sugarcli/pulls)Apache-2.0PHPPHP >=5.3.9 Since Nov 28Pushed 1y ago13 watchersCompare [ Source](https://github.com/inetprocess/sugarcli)[ Packagist](https://packagist.org/packages/inetprocess/sugarcli)[ RSS](/packages/inetprocess-sugarcli/feed)WikiDiscussions master Synced 2mo ago READMEChangelog (10)Dependencies (22)Versions (103)Used By (0) SugarCli ======== [](#sugarcli) SugarCli is a command line tool to install and manage SugarCRM installations. Install ======= [](#install) Get the latest phar archive at `https://github.com/inetprocess/sugarcli/blob/master/build/sugarcli.phar`. Allow the execution and run it. ``` cd /usr/local/bin/ wget 'https://github.com/inetprocess/sugarcli/releases/download/v1.25.8/sugarcli.phar' chmod +x ./sugarcli.phar mv sugarcli.phar sugarcli sugarcli help ``` Or clone this git repository and use `./bin/sugarcli`. Build ===== [](#build) Clone the git repository and run ``` composer install --no-dev --quiet -o mkdir build ulimit -Sn 4096 php -dphar.readonly=0 bin/box build ``` It will build the `sugarcli.phar` Phar archive in the `build` folder. Creating a new phar file and release it as a new version -------------------------------------------------------- [](#creating-a-new-phar-file-and-release-it-as-a-new-version) ``` Draft a new release with a new tag and publish this release On local do, git checkout master git pull Verify the latest tag using the command: git describe --tag --always HEAD The output should contain the latest tag In the repo codebase, make the necessary changes Create a new sugarcli.phar file using the build process mentioned above Create a pull request, update the readme version with the latest release version. Add the latest phar file to this pull request as well. Merge the pull request Navigate to the latest release from browser Edit the release and upload the latest phar file to this release. Publish it. Install the latest phar file from this release link. Check sugarcli version. It should be set to the latest release version. ``` Configuration ============= [](#configuration) You can save some configurations options in different location. The latter one will override the previous one: `/etc/sugarclirc``$HOME/.sugarclirc``./.sugarclirc` Command line parameters will override these configurations. Example ------- [](#example) ``` --- sugarcrm: path: PATH #Path to Sugarcrm relative to the configuration file user_id: USER_ID #SugarCRM user id to impersonate when running the command metadata: file: FILE #Path to the metadata file relative to the configuration file account: name: ACCOUNT_NAME #Name of the account backup: prefix: PREFIX #Prefix to prepend to name of archive file when creating backups maintenance: page: FILE or CONTENT #File name or content of maintenance page allowed_ips: #List of ips allowed to by-pass the maintenance page - IP1 - IP2 - ... ``` Usage ===== [](#usage) - `./sugarcli.phar list`: List all commands available - `./sugarcli.phar namespace:command --help`: Display help for a specific command See the [USAGE.md](USAGE.md) file for a complete list of commands and the associated help Development =========== [](#development) Run tests --------- [](#run-tests) Copy the file `phpunit.xml.dist` to `phpunit.xml` and edit the environment variables. Run the full test suite with `bin/phpunit` or exclude groups to avoid required external resources `bin/phpunit --exclude-group inventory,sugarcrm-db` **Available groups**: - inventory - sugarcrm-db - sugarcrm-path - sugarcrm-url Generate USAGE.md command documentation --------------------------------------- [](#generate-usagemd-command-documentation) ``` bin/sugarcli list --format json | php bin/format_help.php >| USAGE.md ``` ### Health Score 45 — FairBetter than 92% of packages Maintenance49 Moderate activity, may be stable Popularity24 Limited adoption so far Community22 Small or concentrated contributor base Maturity75 Established project with proven stability Bus Factor2 2 contributors hold 50%+ of commits 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 ~48 days Total 80 Last Release 373d ago Major Versions v0.1.0 → v1.0.02014-11-28 PHP version history (2 changes)v1.4.1PHP >=5.3.3 v1.9.1PHP >=5.3.9 ### Community Maintainers ![](https://www.gravatar.com/avatar/1478ac4a9766e3554dd561a9b0a2bec6046e6d58e2865f52a6e5cfde2fb7fc30?d=identicon)[edyan](/maintainers/edyan) ![](https://www.gravatar.com/avatar/7213b17a7e92efdfb0bf04391f80af14a4aa4f8d5f4e1edb53ebad6267ce8166?d=identicon)[rsauvatinet](/maintainers/rsauvatinet) --- Top Contributors [![inetraphael](https://avatars.githubusercontent.com/u/104067766?v=4)](https://github.com/inetraphael "inetraphael (17 commits)")[![salmanahmad-rt](https://avatars.githubusercontent.com/u/85685142?v=4)](https://github.com/salmanahmad-rt "salmanahmad-rt (14 commits)")[![asatti-rt](https://avatars.githubusercontent.com/u/92844029?v=4)](https://github.com/asatti-rt "asatti-rt (11 commits)")[![smtaha01](https://avatars.githubusercontent.com/u/30428141?v=4)](https://github.com/smtaha01 "smtaha01 (5 commits)")[![edyan](https://avatars.githubusercontent.com/u/13624534?v=4)](https://github.com/edyan "edyan (1 commits)")[![ManuelTeissier](https://avatars.githubusercontent.com/u/42801449?v=4)](https://github.com/ManuelTeissier "ManuelTeissier (1 commits)") --- Tags sugarcrmsugarcli ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/inetprocess-sugarcli/health.svg) ``` [![Health](https://phpackages.com/badges/inetprocess-sugarcli/health.svg)](https://phpackages.com/packages/inetprocess-sugarcli) ``` ### Alternatives [shopware/platform The Shopware e-commerce core 3.3k1.5M3](/packages/shopware-platform)[sylius/sylius E-Commerce platform for PHP, based on Symfony framework. 8.4k5.6M651](/packages/sylius-sylius)[sulu/sulu Core framework that implements the functionality of the Sulu content management system 1.3k1.3M152](/packages/sulu-sulu)[prestashop/prestashop PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers. 9.0k15.4k](/packages/prestashop-prestashop)[shopware/core Shopware platform is the core for all Shopware ecommerce products. 595.2M386](/packages/shopware-core)[ec-cube/ec-cube EC-CUBE EC open platform. 78527.0k1](/packages/ec-cube-ec-cube) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)