docs: add missing top-level commands to CLI reference - #198
Open
rajarshidattapy wants to merge 2 commits into
Open
docs: add missing top-level commands to CLI reference#198rajarshidattapy wants to merge 2 commits into
rajarshidattapy wants to merge 2 commits into
Conversation
…i-reference-missing-commands
Contributor
🟢 No documentation gap found — medium confidenceThe automated review found no documentation gap in the supplied changes. This review is advisory and does not block merging. |
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.
Description
Fixes #197
The Top-Level Commands table in
docs/cli-reference.mdxhas drifted from the registered command surface. Three commands are missing entirely, and one row describes a subcommand that does not exist.Missing rows
daemonsrc/cli.ts:3572status,stop,restart)authsrc/commands/auth.ts:457(viaregisterAuthCommands(program))status,refresh)convention-auditsrc/cli.ts:918All three already appear in
src/completion-shared.tslocalOnlyCommands, so shell completion offers them while the published reference does not document them.Incorrect row
skillswas described as "List and read bundled Webcmd agent skills." There is noskills readsubcommand. The actual set islist/add/update/remove(src/cli.ts:857,:872,:893,:908), described in code as "List, add, update, and remove bundled Webcmd skills" (src/cli.ts:845).This one matters beyond accuracy:
webcmd skills addis the second command in the README Quick Start,docs/index.mdx, anddocs/quickstart.mdx— the install step every new user runs — and it appeared nowhere in the command reference, while a capability that does not exist did.Each new row's wording is taken from the command's own
.description()so the table and--helpstay consistent.Related issue:
Type of Change
Checklist
Notes on the checklist:
src/rather than by running the suite.src/docs-sync-review.tslistsdocs/cli-reference.mdxas a watched path only, which is why the drift went unnoticed.Adapter Notes
Not applicable — no adapter is added or modified in this PR.
CliErrorsubclasses instead of rawErrorScreenshots / Output
Net diff against
main— one file, +4 / -1:Scope note
antigravityalso appears incompletion-shared.tslocalOnlyCommandsbut is deliberately not added here. It is a site adapter with 31 commands incli-manifest.json(send,read,history,model,watch, …);src/cli.ts:3670only attaches aservesubcommand to that existing namespace. Listing it in a table of non-adapter commands would raise the question of why the other ~110 adapters are absent. Happy to add it if maintainers prefer otherwise.