Skip to content

Mention "shell-friends" within the command line help too #5794

@porg

Description

@porg

Facts

shell-friends.md https://make.wordpress.org/cli/handbook/references/shell-friends/

✅ is linked to from these web pages:

❗️ It is yet not mentioned from anywhere within the command line help.

Proposal: Rename shell-friends to something more telling

  • "shell-friends" may be fun or amusing, but not very telling at first.
  • I'd rename it to "shell-hints" or "wp-cli plus shell commands combined" or something into that direction.

Proposal: Mention it in the CLI help screen(s) too

Maybe at the very bottom of wp help insert:

SEE ALSO:

wp help shell-hints — Get some tips & tricks how you can make the most of wp-cli in combination with other CLI apps. Composability is a key philosophy of WP-CLI!

Or if not made available as a help page of the app, then:

SEE ALSO:

https://make.wordpress.org/cli/handbook/references/shell-hints/

  • Get some tips & tricks how you can make the most of wp-cli in combination with other CLI apps.
  • Composability is a key philosophy of WP-CLI!
  • Many Terminal apps allow clicking hyperlinks (with right-click or click + modifier key).
  • Or copy and pasting into a web browser will also do.
  • Certainly this measure would help discoverability a bit.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions