PHPackages                             wp-cli/regenerate-readme - 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. [Utility & Helpers](/categories/utility)
4. /
5. wp-cli/regenerate-readme

AbandonedArchivedPhp-composter-action[Utility & Helpers](/categories/utility)

wp-cli/regenerate-readme
========================

PHP Composter action to regenerate the README.md file (pre-commit + post-commit).

v2.0.1(7y ago)11.4kMITPHP

Since Jul 19Pushed 3y ago2 watchersCompare

[ Source](https://github.com/wp-cli/regenerate-readme)[ Packagist](https://packagist.org/packages/wp-cli/regenerate-readme)[ RSS](/packages/wp-cli-regenerate-readme/feed)WikiDiscussions master Synced 2w ago

READMEChangelog (1)Dependencies (4)Versions (4)Used By (0)

wp-cli/regenerate-readme
========================

[](#wp-cliregenerate-readme)

PHP Composter action to regenerate the README.md file (precommit).

Quick links: [Installing](#installing) | [Using](#using) | [Contributing](#contributing) | [Support](#support)

Installing
----------

[](#installing)

Just add as a development requirement to your `composer.json`, and it should work automagically:

```
composer require --dev wp-cli/regenerate-readme
```

Using
-----

[](#using)

It should just work when you `git commit`.

Contributing
------------

[](#contributing)

We appreciate you taking the initiative to contribute to this project.

Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.

For a more thorough introduction, [check out WP-CLI's guide to contributing](https://make.wordpress.org/cli/handbook/contributing/). This package follows those policy and guidelines.

### Reporting a bug

[](#reporting-a-bug)

Think you’ve found a bug? We’d love for you to help us get it fixed.

Before you create a new issue, you should [search existing issues](https://github.com/wp-cli/regenerate-readme/issues?q=label%3Abug%20) to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version.

Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please [create a new issue](https://github.com/wp-cli/regenerate-readme/issues/new). Include as much detail as you can, and clear steps to reproduce if possible. For more guidance, [review our bug report documentation](https://make.wordpress.org/cli/handbook/bug-reports/).

### Creating a pull request

[](#creating-a-pull-request)

Want to contribute a new feature? Please first [open a new issue](https://github.com/wp-cli/regenerate-readme/issues/new) to discuss whether the feature is a good fit for the project.

Once you've decided to commit the time to seeing your pull request through, [please follow our guidelines for creating a pull request](https://make.wordpress.org/cli/handbook/pull-requests/) to make sure it's a pleasant experience. See "[Setting up](https://make.wordpress.org/cli/handbook/pull-requests/#setting-up)" for details specific to working on this package locally.

Support
-------

[](#support)

Github issues aren't for general support questions, but there are other venues you can try:

###  Health Score

31

—

LowBetter than 66% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity19

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity65

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 ~29 days

Total

3

Last Release

2847d ago

Major Versions

v0.1.0 → v2.0.02018-08-05

### Community

Maintainers

![](https://www.gravatar.com/avatar/6dde7f578e5530884238e7173f768ae3a890b6d66eb99262a82f2c494a1b67d4?d=identicon)[schlessera](/maintainers/schlessera)

---

Top Contributors

[![schlessera](https://avatars.githubusercontent.com/u/83631?v=4)](https://github.com/schlessera "schlessera (15 commits)")

---

Tags

hacktoberfest

### Embed Badge

![Health badge](/badges/wp-cli-regenerate-readme/health.svg)

```
[![Health](https://phpackages.com/badges/wp-cli-regenerate-readme/health.svg)](https://phpackages.com/packages/wp-cli-regenerate-readme)
```

###  Alternatives

[wp-cli/core-command

Downloads, installs, updates, and manages a WordPress installation.

5211.3M28](/packages/wp-cli-core-command)[wp-cli/entity-command

Manage WordPress comments, menus, options, posts, sites, terms, and users.

1069.8M82](/packages/wp-cli-entity-command)[wp-cli/scaffold-command

Generates code for post types, taxonomies, blocks, plugins, child themes, etc.

1728.4M22](/packages/wp-cli-scaffold-command)[wp-cli/search-replace-command

Searches/replaces strings in the database.

598.2M8](/packages/wp-cli-search-replace-command)[wp-cli/extension-command

Manages plugins and themes, including installs, activations, and updates.

909.9M81](/packages/wp-cli-extension-command)[wp-cli/checksum-command

Verifies file integrity by comparing to published checksums.

338.3M14](/packages/wp-cli-checksum-command)

PHPackages © 2026

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