CLI helptext cleanup into --help and --help-long
- Dominant language
- Go
- Stars
- 17.1k
- Forks
- 3.2k
- Avg merge
- 3d 18h
- Merged PRs (30d)
- 11
Description
Note from GO triage:
- Our command descriptions are not leveraging `ShortDescription` and `LongDescription` to the fullest
- `LongDescription` is often too long for `--help`, for example `ipfs add --help` – see https://github.com/ipfs/go-ipfs/pull/8952
## Proposed cleanup
Audit all commands and make sure each has a reasonable short and log description.
Desired UX would be:
- enhance the way we use https://github.com/ipfs/go-ipfs-cmds/ to support `--help` and `--help-long`
- `ipfs foo --help` should print `ShortDescription`
- if `LongDescription` is present, `ShortDescription` should have a footer saying "For more information pass --help-long"
- - `ipfs foo --help-long` should print `LongDescription` is present, and fallback to `ShortDescription` otherwise
https://docs.ipfs.io/reference/api/cli/ would default to `--help-long`
Contributor guide
Assessment
This issue has not been assessed yet.