[Feature]: support "help" as a subcommand synonymous with "--help"
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
Research direction
Start at the CLI entry points that parse <command> help, --help, and -h, and compare their current behavior. Clarify whether the change is only an alias or also requires a paged manual, then identify the existing CLI checks for help output and verify the agreed behavior for stdout and the default pager.
Written by the indexing model from the issue text.
Description
Description
Across all the different cloud providers, it becomes easy to forget which option brings up the documentation, manual page, or usage. I frequently find myself typing linode <command> help, only to then have to go back and running linode <command> --help (or -h).
It'd be nice if help as a subcommand was synonymous with --help. It'd be even nicer if a help subcommand brought up a full manual page similar to how AWS cli tools do it. Ideally, you'd then have linode <command> help get you the full, detailed manual page in the default pager and lincode <command> --help give you the summary of supported command-line options on stdout only.
Potential Usage Example
No response
- Dominant language
- Python
- Stars
- 442
- Forks
- 159
- Avg merge
- 7d 21h
- Merged PRs (30d)
- 8
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from linode/linode-cli
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
linode/linode-cli#894 ·
-
enhancement
Difficulty 1/5 Under an hour Newbie friendliness 85/100
linode/linode-cli#859 · 1 comment ·
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 45/100
linode/linode-cli#825 · 1 comment ·
-
enhancement
Difficulty 4/5 3-5 days Newbie friendliness 35/100
linode/linode-cli#788 ·
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 35/100
linode/linode-cli#769 · 7 comments ·
All issues in linode/linode-cli
Similar issues
-
area: harness bug status: needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Human-Agent-Society/reef#625 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 1/5 Under an hour Newbie friendliness 80/100
learningequality/kolibri#15351 · 2 comments ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Name consistency Open
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
eellak/triplestore#65 · 1 comment ·