linode / linode/linode-cli

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

オープン
#868 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

enhancement
主要言語
Python
スター
442
フォーク
159
平均マージ
7日 21時間
マージ済み PR(30日)
8

説明

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

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
cli, cloud
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。