CLI helptext cleanup into --help and --help-long #9035
Labels
kind/enhancement
A net-new feature or improvement to an existing feature
topic/commands
Topic commands
topic/docs
Documentation
Milestone
Note from GO triage:
ShortDescription
andLongDescription
to the fullestLongDescription
is often too long for--help
, for exampleipfs add --help
– see Expand rolling chunker documentation #8952Proposed cleanup
Audit all commands and make sure each has a reasonable short and log description.
Desired UX would be:
--help
and--help-long
ipfs foo --help
should printShortDescription
LongDescription
is present,ShortDescription
should have a footer saying "For more information pass --help-long"ipfs foo --help-long
should printLongDescription
is present, and fallback toShortDescription
otherwisehttps://docs.ipfs.io/reference/api/cli/ would default to
--help-long
The text was updated successfully, but these errors were encountered: