linode / linode/linode-cli

[Feature]: support "help" as a subcommand synonymous with "--help"

Open
#868 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
442
Forks
159
Avg merge
7d 21h
Merged PRs (30d)
8

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 help`, only to then have to go back and running `linode --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 help` get you the full, detailed manual page in the default pager and `lincode --help` give you the summary of supported command-line options on stdout only.

### Potential Usage Example

_No response_

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the CLI entry points that parse ` 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.

Assessment

Tech stack
python
Domain
cli, cloud
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.