Skip to content

docs(cli): document the opencode debug subcommands - #57861

Merged
Tarquinen merged 1 commit into
anomalyco:devfrom
oke3:v1-debug-subcommands
Oct 21, 2026
Merged

Tarquinen merged 1 commit into
anomalyco:devfrom
oke3:v1-debug-subcommands

Conversation

@oke3

@oke3 oke3 commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

Issue for this PR

No issue.

Type of change

  • Documentation

What does this PR do?

The opencode debug section of the CLI reference listed the command and nothing else, while the CLI defines three subcommands under it: agents, config and paths. This documents each one, using the wording the CLI itself uses, including the optional name argument for paths and the paths it accepts.

How did you verify your code works?

Checked against the command definitions in packages/cli/src/commands/commands.ts on this branch, and built the docs site.

Screenshots / recordings

Not a UI change.

Checklist

  • I have tested my changes locally
  • I have not included unrelated changes in this PR

@opencode-agent opencode-agent Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 agents
  • config: List configuration sources
  • paths [name]: Show global paths; the optional name prints 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).

Comment thread packages/web/src/content/docs/cli.mdx Outdated

---

#### config

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
@oke3
oke3 force-pushed the v1-debug-subcommands branch from 3b599d4 to 70c6eb2 Compare October 21, 2026 17:17
@oke3

oke3 commented Oct 21, 2026

Copy link
Copy Markdown
Contributor Author

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 (skill, info, startup, scrap, lsp, rg, file, snapshot, v2, wait) would error for a v2 user.

The section now documents agents, config and paths [name] with the CLI's own wording, including the optional name argument and the paths it accepts (db, home, data, config, cache, state, tmp, bin, log, repos).

For the record on where the v1 list came from: those thirteen subcommands are the v1.19.3 CLI's opencode debug set, which I read from the released binary and the v1 tag. That was the wrong product line for this page — thanks for the correction.

@Tarquinen
Tarquinen enabled auto-merge (squash) October 21, 2026 17:28
@Tarquinen
Tarquinen merged commit 8a360e1 into anomalyco:dev Oct 21, 2026
14 checks passed
@opencode-agent opencode-agent Bot mentioned this pull request Oct 23, 2026
3 of 6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants