Skip to content

Generate CLI help docs from args and restructure README - #172

Open
ryuma-1 wants to merge 24 commits into
nomlab:mainfrom
ryuma-1:chore/update-readme
Open

ryuma-1 wants to merge 24 commits into
nomlab:mainfrom
ryuma-1:chore/update-readme

Conversation

@ryuma-1

@ryuma-1 ryuma-1 commented Oct 30, 2026

Copy link
Copy Markdown

概要

※ このブランチは #171 を含んでいるため,#171 を先にマージしてから本 PR をマージすること.

cli の README が全体の見通しが悪く,章構成も rask の README と大きく異なっていた.また,引数定義(args.rs)と内容がずれやすいという問題もあった.
そこで,コマンドの詳細を別ファイルに分割し,README の章構成を修正した.

具体的には,args.rs の各サブコマンドとオプションにヘルプ文を追加し,docs/CommandLineHelp.md を clap-markdown でこのヘルプ文から生成するようにした.これにより,生成結果と既存ファイルの一致は cargo test で検査し,ずれていればテストが失敗するようになった(再生成は UPDATE_DOCS=1 cargo test).あわせて,--url の説明が api_key と同じ文になっていた誤りも修正した.
README は What is rask-cli?/Setup / Usage / Development の構成に整理し,コマンドの詳細は docs/CommandLineHelp.md へのリンクに置き換えた.また,英語版の README.en.md も追加した.

ryuma-1 and others added 24 commits June 19, 2026 11:03
rask-cli Enhance document listing to support JSON output format
Add -n option to task list command
clap does not allow an argument to be both global and required.
Running any subcommand in a debug build panicked with
"Global arguments cannot be required".

Set `required = false` on `api_key` so it remains a global argument.
@ryuma-1 ryuma-1 changed the title Chore/update readme Generate CLI help docs from args and restructure README Oct 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants