linode / linode/linode-cli

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

Offen
#868 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

enhancement
Vorherrschende Sprache
Python
Sterne
442
Forks
159
Ø Merge
7 T. 21 Std.
Gemergte PRs (30 T.)
8

Beschreibung

### 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_

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
cli, cloud
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.