oldwinter / oldwinter/all-cli

设计:README Usage 和 --help 示例都不把 catalog 当发现入口

Open Beginner friendly
#57 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
1
Forks
0
Avg merge
7d 23h
Merged PRs (30d)
24

Description

用户路径

第一次跑 all-cli --help 或打开 README Usage

  • help 的 Example 只有 status --jsonstatus --toolskubectl currentdocker list
  • README Usage 直接从 Version metadata 开始,没有一张和 cobra 分组对齐的命令地图。
  • catalog(不跑外部命令就能浏览工具)和 current(一眼看上下文)要滚到很后面才出现。

本轮不碰已有 issue:#54 doctor vs diagnose 帮助文案、#55 options 漏 --no-progress、#56 catalog 无匹配没有下一步。

摩擦点

命令发现。人不知道「先 catalog 再 status」;help 示例也不展示不打外部命令的入口。

建议改动

  • README Usage 开头加一张 Primary / Cloud / Tools 命令表,和 setSubcommandGroups 对齐。
  • all-cli --help 的 Example 加上 all-cli catalog

不在范围内

  • 不改 doctor / diagnose Short。
  • 不改 catalog 无匹配文案。
  • 不 push、不开 PR、不 merge。

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 with the README Usage section and run all-cli --help to compare the current command discovery paths. Search the Go code for setSubcommandGroups and the help Example definition, then update the README command map and add all-cli catalog to the example. Done means the map aligns with the command groups and both entry points surface catalog without changing the excluded issues.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.