PHPackages samwilson/console-readme-generator - 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. samwilson/console-readme-generator ActiveLibrary[CLI & Console](/categories/cli) samwilson/console-readme-generator ================================== A tool to add command documentation 0.3.3(2y ago)22.3k[4 issues](https://github.com/samwilson/console-readme-generator/issues)1MITPHPCI failing Since Apr 19Pushed 2y ago1 watchersCompare [ Source](https://github.com/samwilson/console-readme-generator)[ Packagist](https://packagist.org/packages/samwilson/console-readme-generator)[ RSS](/packages/samwilson-console-readme-generator/feed)WikiDiscussions main Synced 1w ago READMEChangelog (6)Dependencies (7)Versions (7)Used By (1) Readme Generator for Symfony Console ==================================== [](#readme-generator-for-symfony-console) A small tool for adding Symfony Console command documentation to projects' Readme files. Configuration ------------- [](#configuration) 1. Add a `## Usage` header to your Readme (the name of this section can be configured; see below). 2. Add the `generate-readme` command to your Application, e.g. in `./bin/console`: ``` $application->add(new \Samwilson\ConsoleReadmeGenerator\Command\ReadmeGenCommand()); ``` 3. Run the command, e.g. `./bin/console generate-readme`. This will modify your `README.md` file. The usage documentation below is an example of the output. [![CI](https://github.com/samwilson/console-readme-generator/actions/workflows/ci.yml/badge.svg)](https://github.com/samwilson/console-readme-generator/actions/workflows/ci.yml) Usage ----- [](#usage) ### generate-readme [](#generate-readme) Generate command documentation for a Readme file. ``` generate-readme [-i|--include INCLUDE] [-r|--readme README] [-u|--usage USAGE] ``` - `--include` `-i` — Explicitly include a command (e.g. "app:foo") or namespace (e.g. "app:" with trailing colon). This option can be provided multiple times. - `--readme` `-r` — Path (including filename) of the README file to modify. Default: '\[CWD\]/README.md' - `--usage` `-u` — Name of the section in the README file in which to insert the documentation. Default: 'Usage' License: MIT ------------ [](#license-mit) Copyright 2021 Sam Wilson. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ### Health Score 22 — LowBetter than 22% of packages Maintenance0 Infrequent updates — may be unmaintained Popularity22 Limited adoption so far Community11 Small or concentrated contributor base Maturity46 Maturing project, gaining track record Bus Factor1 Top contributor holds 88.9% 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 ~222 days Recently: every ~193 days Total 6 Last Release 744d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/a0281a00958518a98244b8a6052f91e86d1599aebf9b7bb6c55bca30d98774e7?d=identicon)[samwilson](/maintainers/samwilson) --- Top Contributors [![samwilson](https://avatars.githubusercontent.com/u/213655?v=4)](https://github.com/samwilson "samwilson (8 commits)")[![waldyrious](https://avatars.githubusercontent.com/u/478237?v=4)](https://github.com/waldyrious "waldyrious (1 commits)") --- Tags readme-generatorsymfony-console ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/samwilson-console-readme-generator/health.svg) ``` [![Health](https://phpackages.com/badges/samwilson-console-readme-generator/health.svg)](https://phpackages.com/packages/samwilson-console-readme-generator) ``` ### Alternatives [illuminate/console The Illuminate Console package. 12944.1M5.1k](/packages/illuminate-console)[crazywhalecc/static-php-cli Build single static PHP binary, with PHP project together, with popular extensions included. 1.8k13.9k](/packages/crazywhalecc-static-php-cli)[matthiasnoback/symfony-console-form Use Symfony forms for Console command input 368264.8k8](/packages/matthiasnoback-symfony-console-form)[phpcr/phpcr-shell Shell for PHPCR 721.3M8](/packages/phpcr-phpcr-shell)[madewithlove/license-checker CLI tool to verify allowed licenses for composer dependencies 54449.8k21](/packages/madewithlove-license-checker)[shel/neos-terminal Neos CMS Ui terminal for running Eel expressions and other commands 1441.3k](/packages/shel-neos-terminal) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)