Skip to content

Add command aliases to README.md output by wp scaffold package-readme #264

Closed

Description

@baizmandesign

The README.md output by wp scaffold package-readme does not include @alias directive information (alternative names for a given command as described here). I think it would be good to include it either by default (my preference) or via a flag such as below:

wp scaffold package-readme --include-aliases

Activity

  1. transferred this issue fromwp-cli/ideason Jan 9, 2026
  2. swissspidy commented on Jan 9, 2026

    @swissspidy
    Member

    Makes sense to me!

    We just recently enabled this for the handbook already via wp-cli/wp-cli#6147 and wp-cli/handbook#605 so this should be trivial to do.

    We can include this by default, with a simple line like:

    **Alias:** `xyz`
    
  3. baizmandesign commented on Jan 9, 2026

    @baizmandesign
    Author

    @swissspidy Thanks! Out of curiosity, are multiple command aliases allowed? It appears only the first mention of @alias in the command definition is honored.

  4. swissspidy commented on Jan 9, 2026

    @swissspidy
    Member

    Only a single alias is supported at the moment.

  5. baizmandesign commented on Jan 9, 2026

    @baizmandesign
    Author

    Thanks @swissspidy!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions