PHPackages                             jwpage/composerdoc - 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. jwpage/composerdoc

AbandonedArchivedLibrary[CLI & Console](/categories/cli)

jwpage/composerdoc
==================

Console tool for displaying package documentation.

v2.0.0(12y ago)16312MITPHP

Since Jan 21Pushed 12y ago1 watchersCompare

[ Source](https://github.com/jwpage/composerdoc)[ Packagist](https://packagist.org/packages/jwpage/composerdoc)[ RSS](/packages/jwpage-composerdoc/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (2)Versions (6)Used By (0)

Composerdoc Command Line Utility
================================

[](#composerdoc-command-line-utility)

\[[![Build Status](https://camo.githubusercontent.com/b52522ec80d791097bb474ae8135b9ea6c7857ac5837078b0af71f37258f098d/68747470733a2f2f7472617669732d63692e6f72672f6a77706167652f636f6d706f736572646f632e706e67)](https://camo.githubusercontent.com/b52522ec80d791097bb474ae8135b9ea6c7857ac5837078b0af71f37258f098d/68747470733a2f2f7472617669732d63692e6f72672f6a77706167652f636f6d706f736572646f632e706e67)\](. org/jwpage/composerdoc)

Composerdoc is a tool that allows you to dump a listing of the required packages within your project to a markdown format for documentation purposes.

Installation
------------

[](#installation)

Add this to your `composer.json` by running `composer.phar require jwpage/composerdoc --dev`.

Or alternatively, as Composerdoc is a documentation tool, you can install it separately and run it with the `--path` option.

```
echo -n '{ "require": { "jwpage/composerdoc": "*" } }' > composer.json
composer.phar install

```

Usage
-----

[](#usage)

### `composerdoc dump`

[](#composerdoc-dump)

To generate composerdoc output:

```
./vendor/bin/composerdoc --path

```

To include dev requirements:

```
./vendor/bin/composerdoc --dev

```

To include requirements of requirements:

```
./vendor/bin/composerdoc --sub

```

### `composerdoc check`

[](#composerdoc-check)

You can use composerdoc to check if a README file has the latest composerdoc information.

```
./vendor/bin/composerdoc --path

```

This command takes the same options as the `composerdoc dump` command.

### `composerdoc update`

[](#composerdoc-update)

You can also automatically update a README file with the latest composerdoc information in one command.

```
./vendor/bin/composerdoc --path

```

This command takes the same options as the `composerdoc dump` command.

Example Output
--------------

[](#example-output)

Required Packages

- composer/composer: Package Manager:
    - justinrainbow/json-schema: A library to validate a json schema.:
    - seld/jsonlint: JSON Linter: none
    - symfony/console: Symfony Console Component:
    - symfony/finder: Symfony Finder Component:
    - symfony/process: Symfony Process Component:
- symfony/console: Symfony Console Component:

Dev Packages

- phpunit/phpunit: The PHP Unit Testing framework.:
    - phpunit/php-file-iterator: FilterIterator implementation that filters files based on a list of suffixes.:
    - phpunit/php-text-template: Simple template engine.:
    - phpunit/php-code-coverage: Library that provides collection, processing, and rendering functionality for PHP code coverage information.:
    - phpunit/php-timer: Utility class for timing:
    - phpunit/phpunit-mock-objects: Mock Object library for PHPUnit:
    - symfony/yaml: Symfony Yaml Component:

Running Tests
-------------

[](#running-tests)

First, install PHPUnit with `composer.phar install --dev`, then run `./vendor/bin/phpunit`.

###  Health Score

31

—

LowBetter than 68% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity16

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity67

Established project with proven stability

 Bus Factor1

Top contributor holds 100% 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 ~42 days

Total

5

Last Release

4696d ago

Major Versions

v1.1.1 → v2.0.02013-07-10

### Community

Maintainers

![](https://www.gravatar.com/avatar/3e9c174f9276d256ac0e92c334a7d342a8140ad538138d5275de9e66ac4c92eb?d=identicon)[jwpage](/maintainers/jwpage)

---

Top Contributors

[![jwpage](https://avatars.githubusercontent.com/u/52687?v=4)](https://github.com/jwpage "jwpage (33 commits)")

---

Tags

composerdocumentation

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/jwpage-composerdoc/health.svg)

```
[![Health](https://phpackages.com/badges/jwpage-composerdoc/health.svg)](https://phpackages.com/packages/jwpage-composerdoc)
```

###  Alternatives

[brainmaestro/composer-git-hooks

Easily manage git hooks in your composer config

1.1k9.1M444](/packages/brainmaestro-composer-git-hooks)[codedungeon/php-cli-colors

Liven up you PHP Console Apps with standard colors

10210.1M26](/packages/codedungeon-php-cli-colors)[globtec/phpadr

A PHP based command-line interface tool for working with ADR

80216.0k1](/packages/globtec-phpadr)[mwguerra/interactive-upgrader

A CLI tool that handles both Composer and npm dependencies for Laravel projects.

1913.7k](/packages/mwguerra-interactive-upgrader)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)