Repository navigation
Generate the qw command reference from the CLI's usage strings #45
Description
Activity
🔗 Related PRs
#20 - Rewrite README around witnessed causal history [merged]
📝 Issue Planner
Check the box below or use the
@coderabbitai plancommand to generate an implementation plan and prompts that you can use with your favorite coding assistant.- Create Plan
🧪 Issue enrichment is currently in open beta.
You can configure auto-planning by selecting labels in the issue_enrichment configuration.
To disable automatic issue enrichment, add the following to your
.coderabbit.yaml:issue_enrichment: auto_enrich: enabled: false
💬 Have feedback or questions? Drop into our discord!
docs/reference/qw-cli.mdis a hand-maintained command reference, but thecanonical command/flag list already lives in
apps/warp/src/cli.mjsas therenderUsage/renderInstallUsage/renderWarpspaceUsage/render*Usagestrings the CLI prints. The two will drift.
Per
docs/DOCUMENTATION_POLICY.md§3 ("generate what machines already know")the reference should be generated from, or validated against, the CLI itself —
e.g. a script that renders the usage surface to a Markdown fragment, plus a
docs-lint check that the committed reference matches. Then a new flag updates one
place and the docs follow.
Bonus: the same generator could assert every documented command/flag exists in
the parser and vice-versa, closing the gap this audit found by hand
(
qw build/qw doctorwere documented as runnable but never existed).