Skip to content

feat(cli): add a beginner help surface - #59

Open
Windsor Nguyễn (windsornguyen) wants to merge 1 commit into
feat/unified-project-rustfrom
feat/progressive-cli
Open

feat(cli): add a beginner help surface#59
Windsor Nguyễn (windsornguyen) wants to merge 1 commit into
feat/unified-project-rustfrom
feat/progressive-cli

Conversation

@windsornguyen

@windsornguyen Windsor Nguyễn (windsornguyen) commented Aug 12, 2026

Copy link
Copy Markdown
Member

Depends on #57.

What does this change?

This PR adds separate beginner and complete help views without adding another command parser.

  • bsmr -h shows build, init, and clean.
  • bsmr --help shows the complete public command interface.
  • The CLI generates a Markdown reference from the Clap command tree.
  • Hidden commands remain hidden at all nesting levels.
  • CI fails when the checked-in reference differs from the parser output.

The PR adds 6,107 lines. The generated CLI reference contains 5,939 of those lines.

How was it tested?

  • cargo fmt --all -- --check.

  • cargo test -p bsmr --lib help_.

  • cargo test -p bsmr_cmd_docs_client --lib all_commands_doc_tracks_visible_parser_surface.

  • target/debug/bsmr docs markdown-help-doc all > /tmp/bsmr-cli-reference.md.

  • diff -u docs/reference/cli.md /tmp/bsmr-cli-reference.md reported no differences.

  • pnpm run ci check.

  • CLA/Vouch check passes, or this PR only updates VOUCHED.td.

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.

2 participants