Skip to content
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.

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

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

Open
porg opened this issue Jun 1, 2023 · 1 comment
Open

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

porg opened this issue Jun 1, 2023 · 1 comment

Comments

@porg
Copy link

porg commented Jun 1, 2023

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.
@danielbachhuber
Copy link
Member

Thanks for the suggestion, @porg !

I'm not sure it makes sense to link to Shell Friends from the CLI context, but it would probably be worth linking to the handbook.

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

No branches or pull requests

2 participants