Repository navigation
docs(cli): document the opencode debug subcommands - #57861
Conversation
There was a problem hiding this comment.
Thanks for filling in this section. As written, though, it documents the wrong CLI. This page is on dev, where the CLI is v2, and recent docs work has been bringing this page in line with v2 (#56922, and #57419, which removes the v1-only opencode agent section). In v2, packages/cli/src/commands/commands.ts defines only three debug subcommands:
agents: List all agentsconfig: List configuration sourcespaths [name]: Show global paths; the optionalnameprints a single path (db,home,data,config,cache,state,tmp,bin,log,repos)
skill, info, startup, scrap, lsp, rg, file, snapshot, v2 and wait don't exist in v2, and agent is agents there. Running them gives users an error. Could you narrow the section to these three, using v2's own wording, and include the paths argument?
I checked this by comparing the docs with the command definitions on this branch and on the latest dev. It's a docs-only change, so there was nothing to run. Public API: unchanged (documentation only).
|
|
||
| --- | ||
|
|
||
| #### config |
There was a problem hiding this comment.
These sections come from the v1 (1.19.3) binary, but the CLI on dev is v2, and its debug command (packages/cli/src/commands/commands.ts) only has agents, config ("List configuration sources") and paths [name]. Please drop skill, info, startup, agent, scrap, lsp, rg, file, snapshot, v2 and wait, add agents, and document the optional name argument of paths (db, home, data, config, cache, state, tmp, bin, log, repos).
The CLI reference listed the debug command and nothing else, while the CLI defines agents, config and paths under it.
3b599d4 to
70c6eb2
Compare
|
Narrowed to the three v2 subcommands, as you suggested — you are right that this page is being brought in line with v2, and the v1-only subcommands ( The section now documents For the record on where the v1 list came from: those thirteen subcommands are the v1.19.3 CLI's |
Issue for this PR
No issue.
Type of change
What does this PR do?
The
opencode debugsection of the CLI reference listed the command and nothing else, while the CLI defines three subcommands under it:agents,configandpaths. This documents each one, using the wording the CLI itself uses, including the optionalnameargument forpathsand the paths it accepts.How did you verify your code works?
Checked against the command definitions in
packages/cli/src/commands/commands.tson this branch, and built the docs site.Screenshots / recordings
Not a UI change.
Checklist