You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I find that the single-page layout of a man page aids with the discoverability of features of a command. While I'm looking for details of the option I need help with, I often see something that I wasn't previously aware of or had forgotten.
This sort of discoverability doesn't exist in the wp help command as it only lists the top level subcommands. Some form of extended help view which lists the description and complete synopsis for every available command could help with discoverability. A trimmed example is below.
$ man wp
NAME
wp
DESCRIPTION
Manage WordPress through the command-line.
SYNOPSIS
wp <command>
SUBCOMMANDS
wp cache add <key> <value> [<group>] [<expiration>]
Add a value to the object cache.
wp cache decr <key> [<offset>] [<group>]
Decrement a value in the object cache.
If we want to bridge the gap between the console (where the "product" is being used) and the web (where the "product" is being documented and worked on), we need to define in what form hyperlinks can or should be used in console output.
This is a placeholder issue for potential improvements to the help screens:
Show disabled commands with the reason why they were disabled
From wp-cli/wp-cli#4035
Extended help view, or a man page
From wp-cli/wp-cli#4565
Web links in console output
See wp-cli/wp-cli#4158
The text was updated successfully, but these errors were encountered: