Repository navigation
docs: generate a matrix of commands and options in each build - #35
Merged
Merged
Conversation
This was referenced Oct 22, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Tier: medium (docs plus a new Rust example target; no src change)
docs/cli-matrix.mdanddocs/cli-matrix.json: every command and option of the Python and Rust builds onmain, classified as both / python-only / rust-only / hidden / pending, plus a hand-kept behavior table.docs/cli_matrix.py(generator,--checkmode) andrust/examples/cli_options.rs, which dumps the clap command tree (hidden options included) as JSON.site/changes; the JSON is meant for the site lane's reference check.Sources. The Python build is read from Typer the way
site/scripts/check_reference.pyreads it; the Rust build from clap itself (Cli::command()), not from--helptext, because--helphides--no-copyandterm ingest.JSON for the reference check.
"python"and"rust"map each command path to its sorted option names, the shapecheck_reference.cli_options()returns. Checked locally:"python"equalscli_options()exactly (sets compared as sorted lists), and the Rust build has the same command paths, with one extra option,term --raw.What the matrix shows on
main(c1c4d11): 21 commands in both builds (term ingesthidden in both); 64 options in both, 1 Rust only (term --raw), 0 Python only. Differences in names:--versionalso takes-Vin Rust;--no-copyis hidden from Rust's--helpbut listed by Python's. Pending (not onmain): the remote scan options ofscan(Python in #33, Rust waits for the decision in DotFiles#81) andmcp --allow-remote(planned in #30). Nothing in either build is marked experimental, so that category is empty and says so.Behavior table. Differences that are not options (digest languages, outlines of broken Python,
packmodule order, Ctrl+C incap, status line endings, remote scan) are copied by hand fromrust/README.md"Differences from the Python build"; the generator says so and does not check them.Tests:
uv run python docs/cli_matrix.py --checkpasses after generation;cargo clippy --example cli_options -- -D warningsandcargo fmt --checkclean;ruff@0.17.1 check/format --checkclean;conventions.py check0 findings. Not added: a CI step that runs--check(it needs cargo in the Python job, or the Rust job to run the Python script); proposed for a follow-up.