Repository navigation
docs(cli): replace v1-only command sections with v2 equivalents - #58016
KasabuNikhilGoud wants to merge 2 commits into
Conversation
Remove the attach, github, web, pr and db sections, whose commands no longer exist in v2, and fold session export/import into the session section where the v2 equivalents live. Closes anomalyco#57957
There was a problem hiding this comment.
Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.
An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing.
github-actions
Bot
added
the
needs:compliance
|
This PR doesn't fully meet our contributing guidelines and PR template. What needs to be fixed:
Please edit this PR description to address the above within 72 hours, or it will be automatically closed. If you believe this was flagged incorrectly, please let a maintainer know. |
![opencode-agent[bot]](https://avatars.githubusercontent.com/in/1549082?s=60&v=4){kind=small}
There was a problem hiding this comment.
The change looks correct. I compared each edited section with packages/cli/src/commands/commands.ts: all seven v1 ### sections are gone, and every remaining top-level section matches a registered command. The session export/session import usage and flags, the root --server flag and the claim that serve also serves the web interface all match the code. Docs-only change, so there was nothing to run.
Public API: unchanged (documentation only).
One thing worth fixing: packages/console/app/src/routes/download/index.tsx (line 414) links to /docs/cli/#web. That section no longer exists after this change, so the download page FAQ link will open the top of the CLI page instead. Pointing it at /docs/web or /docs/cli/#serve would keep it working. Other English pages (web.mdx, server.mdx, config.mdx, windows-wsl.mdx) and the translated cli.mdx copies still mention opencode web/opencode attach. Leaving those for a follow-up, as you noted, is fine.
/docs/cli/#web stopped existing after the v1 web section was removed from the CLI docs page.
|
So the translation cleanup does not get lost while this lands: #58207 removes the It also fixes the If you would rather fold either into this PR, say so and I will close #58207. |
|
This pull request has been automatically closed because it was not updated to meet our contributing guidelines within the 72-hour window. Feel free to open a new pull request that follows our guidelines. |
github-actions
Bot
removed
the
needs:compliance
Issue for this PR
Closes #57957
Type of change
What does this PR do?
A reader following the CLI docs page would run v1 commands (
opencode attach,web,db,export,import,github,pr) that no longer exist in v2. I removed the five sections whose commands are gone, documented the real v2 replacements (opencode session export|import) where they live undersession, and noted onservethat it serves the web interface and thatopencode --server <url>connects a remote server. TheOPENCODE_SERVER_PASSWORDenv table row no longer mentionsweb.Also points the download FAQ's web link at
/docs/websince/docs/cli/#webno longer exists (flagged in review). Translated CLI docs and other stale flag tables are left for a follow-up.How did I verify my code works?
Compared every edited section against the v2 command registry (
packages/cli/src/commands/commands.ts): no remaining documented command is unregistered. Grepped the page for references to removed commands. Docs change; nothing to run.Screenshots / recordings
Not applicable (no UI change).
Checklist
Added by the opencode bot (AI-generated).
Related: #51574, #56800