PHPackages vanilla/vanilla-cli - 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. vanilla/vanilla-cli AbandonedArchivedProject[CLI & Console](/categories/cli) vanilla/vanilla-cli =================== Vanilla Forums Command Line Interface. Simplify common forum development related tasks. v1.8.1(5y ago)28472[10 issues](https://github.com/vanilla/vanilla-cli/issues)[9 PRs](https://github.com/vanilla/vanilla-cli/pulls)MITPHPPHP >=5.6.0 Since Aug 18Pushed 3y ago1 watchersCompare [ Source](https://github.com/vanilla/vanilla-cli)[ Packagist](https://packagist.org/packages/vanilla/vanilla-cli)[ RSS](/packages/vanilla-vanilla-cli/feed)WikiDiscussions master Synced 5d ago READMEChangelog (10)Dependencies (1)Versions (39)Used By (0) Vanilla's Command Line Interface ================================ [](#vanillas-command-line-interface) This tool is used to make various tasks easier for developers working on Vanilla Forums core or addons. Current functionalities include: - Building frontend assets (scripts, stylesheets, and images) - Generating cache files for addons - Converting addons' info arrays to json See the [vanilla-cli docs](https://docs.vanillaforums.com/developer/vanilla-cli) for documentation about the different commands. Table of Contents ----------------- [](#table-of-contents) - [Installation](#installation) - [Basic Usage](#usage) - [Documentation](#documentation) - [Tests](#tests) - [Debugging](#debugging) Installation ------------ [](#installation) See our [Installation Docs](https://docs.vanillaforums.com/developer/vanilla-cli/installation/) and our [Quickstart Guide](https://docs.vanillaforums.com/developer/vanilla-cli/build-quickstart/). Basic Usage ----------- [](#basic-usage) - From the command line: ``` vanilla --help ``` or ``` vanilla SOME_COMMAND --help ``` - From other php applications: ``` require('{{VANILLA_CLI_DIRECTORY}}/vendor/autoload.php'); $cli = new \Vanilla\Cli\Cli(); try { $cli->run($args); // Must be: array('vanilla', '{{COMMAND_NAME}}'[, options...]) } catch (Exception $e) { ... } ``` Documentation ------------- [](#documentation) More detailed usage documentation can be found at our official [vanilla-cli docs](https://docs.vanillaforums.com/developer/vanilla-cli/#usage). - [Getting Started](https://docs.vanillaforums.com/developer/vanilla-cli/#getting-started) - [Build Tools](https://docs.vanillaforums.com/developer/vanilla-cli/#build-tools) - [Addon Utilities](https://docs.vanillaforums.com/developer/vanilla-cli/#addon-utilities) - [Build Tool Quickstart Guide](https://docs.vanillaforums.com/developer/vanilla-cli/build-quickstart) - [Build Process - Core](https://docs.vanillaforums.com/developer/vanilla-cli/build-process-core) - [Build Process - 1.0](https://docs.vanillaforums.com/developer/vanilla-cli/build-process-v1) - [Build Process - Legacy](https://docs.vanillaforums.com/developer/vanilla-cli/build-process-legacy) - [How Bundling Works](https://docs.vanillaforums.com/developer/vanilla-cli/bundling-process) Tests ----- [](#tests) Some of the node.js build processes have unit and integration tests. Be sure that these pass before making pull requests. To run the tests: The NodeTools tests are run using [jest](https://facebook.github.io/jest/). ``` $ yarn install $ yarn test # Or $ yarn test --watch ``` Debugging --------- [](#debugging) During local development you may want to run a debugger. This is supported for the primary PHP process. ### PHP [](#php) Ensure you IDE is properly configured for [`XDebug`](https://xdebug.org/index.php). [How to setup PHPStorm for XDebug](https://www.jetbrains.com/help/phpstorm/configuring-xdebug.html) [Debugging in VsCode](https://code.visualstudio.com/Docs/editor/debugging) #### Running the Debugger [](#running-the-debugger) Just export `XDEBUG_CONFIG` from your shell, set up your IDE to listen for XDebug, and run your vanilla command. ``` export XDEBUG_CONFIG="idekey=PHPSTORM" vanilla some-command --some-argument ``` ### Health Score 29 ↓ LowBetter than 59% of packages Maintenance0 Infrequent updates — may be unmaintained Popularity18 Limited adoption so far Community17 Small or concentrated contributor base Maturity70 Established project with proven stability Bus Factor1 Top contributor holds 83.1% 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 ~65 days Recently: every ~101 days Total 18 Last Release 2090d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/da29e060f227028e8ee38bb5873ba2188fb5236b20b3dffec766c768019d8bd8?d=identicon)[tburry](/maintainers/tburry) ![](https://www.gravatar.com/avatar/021b2a80f2781914dbb04a3aec8fa98a286915043f9b695cc158416c0c681b1e?d=identicon)[kaecyra](/maintainers/kaecyra) --- Top Contributors [![charrondev](https://avatars.githubusercontent.com/u/1770056?v=4)](https://github.com/charrondev "charrondev (275 commits)")[![DaazKu](https://avatars.githubusercontent.com/u/2412909?v=4)](https://github.com/DaazKu "DaazKu (40 commits)")[![tburry](https://avatars.githubusercontent.com/u/97432?v=4)](https://github.com/tburry "tburry (5 commits)")[![initvector](https://avatars.githubusercontent.com/u/1390241?v=4)](https://github.com/initvector "initvector (4 commits)")[![cdepage](https://avatars.githubusercontent.com/u/1389342?v=4)](https://github.com/cdepage "cdepage (2 commits)")[![linc](https://avatars.githubusercontent.com/u/117672?v=4)](https://github.com/linc "linc (2 commits)")[![dlacaille](https://avatars.githubusercontent.com/u/6683854?v=4)](https://github.com/dlacaille "dlacaille (2 commits)")[![R-J](https://avatars.githubusercontent.com/u/3996187?v=4)](https://github.com/R-J "R-J (1 commits)") --- Tags non-production ### Embed Badge ![Health badge](/badges/vanilla-vanilla-cli/health.svg) ``` [![Health](https://phpackages.com/badges/vanilla-vanilla-cli/health.svg)](https://phpackages.com/packages/vanilla-vanilla-cli) ``` ### Alternatives [wp-cli/wp-cli WP-CLI framework 5.0k17.2M320](/packages/wp-cli-wp-cli)[consolidation/annotated-command Initialize Symfony Console commands from annotated command class methods. 22569.8M19](/packages/consolidation-annotated-command)[chi-teck/drupal-code-generator Drupal code generator 26947.8M5](/packages/chi-teck-drupal-code-generator)[seld/cli-prompt Allows you to prompt for user input on the command line, and optionally hide the characters they type 24725.8M17](/packages/seld-cli-prompt)[illuminate/console The Illuminate Console package. 12944.1M5.1k](/packages/illuminate-console)[php-tui/php-tui Comprehensive TUI library heavily influenced by Ratatui 589747.0k6](/packages/php-tui-php-tui) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)