Repository navigation
Learn site: a task-first "Command line" page - #175
Merged
Merged
Conversation
keyroostctl had no single place that walks a non-technical reader through everyday jobs: choosing a key, PINs, passkeys, codes, importing from an app, certificates, OpenPGP, notes, resets, scripts and troubleshooting. The new page does that with copy-paste commands and the output keyroost actually prints, and ends with every command and its description. That reference is generated from the --help tree by packaging/gen-cli-reference.py, and check-docs-mechanical.sh now fails when it falls behind the binary, so it can't drift the way hand-copied command lists did. Every topic page links to its matching section, the top-level --help points to the page, and TODO.md trades the finished item for the v0.14.0 PIV .p12 import (#174). Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Skvxkb6eMzytjPDmL6mPYU
The Learn page's "Every command" table is generated from --help. Its check only ran in the release docs audit, so a renamed command would leave the page wrong until the next release. The Linux test job now runs the check with the keyroostctl that `cargo test` already built. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Skvxkb6eMzytjPDmL6mPYU
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.
A new Learn page, "Command line" (
docs/cli.html), so people can learnkeyroostctlby task instead of reading--help.What's on it
--helpbypackaging/gen-cli-reference.py; its--checkruns in the docs audit and now in CI, so a renamed command fails the PR until the page is updated.Also
keyroostctl --helpends with a link to the page.Checked: every command on the page runs against the real CLI (docs check); CLI tests, clippy and fmt pass; viewed at desktop and phone width.
🤖 Generated with Claude Code
https://claude.ai/code/session_01Skvxkb6eMzytjPDmL6mPYU