Skip to content

Updated documentation for “scaffold package-readme.” #272

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
baizmandesign wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Updated documentation for “scaffold package-readme.” #272

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3232660
Updated documentation for “scaffold package-readme.”
baizmandesign Jan 15, 2026
65ca0b1
Fixed whitespace.
baizmandesign Jan 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions src/ScaffoldPackageCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,23 @@ public function package( $args, $assoc_args ) {
* }
* ```
*
* **Important:** for the `package-readme` subcommand to work properly, your
* package must be loaded by WP CLI. You may load your package in one of two
Copy link

@gemini-code-assist gemini-code-assist bot Jan 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For consistency with the rest of the project's documentation and the WP-CLI brand, WP CLI should be written as WP-CLI.

	 * package must be loaded by WP-CLI. You may load your package in one of two

* ways:
*
* * install the package locally (e.g., from the filesystem via `wp package install /path/to/package`)
* * add a `wp-cli.yml` file in your project directory requiring your package. Here's an example:
Copy link
Member

@swissspidy swissspidy Jan 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a third way would be to manually do --require=path/to/package

*
* ```
* require:
* - your-package.php
Copy link
Member

@swissspidy swissspidy Jan 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* - your-package.php
* - your-package.php

* ```
*
* If your project uses [Composer](https://getcomposer.org)'s autoloader
* and your package is not installed locally, you'll need to generate the
* necessary autoload files by running `composer dump-autoload` in the
* project directory.
*
* You can also customize the rendering of README.md generally with
* composer.json -> 'extra' -> 'readme'. For example, runcommand/hook's
* composer.json includes:
Expand Down