Repository navigation
docs(cli): drop the attach command from the CLI reference - #58204
LuisAlbertoMK wants to merge 1 commit into
Conversation
opencode attach is not a v2 command. It exits 1 and prints the root usage, because the word is read as the project directory. Connecting to a server is the root --server flag now, and the flag table never documented it. Remove the section from every locale, matching the cleanup of the removed agent command in anomalyco#57419. Document --server and --standalone in the root flag table, and fix the run example that still passed --attach. Part of anomalyco#57957.
github-actions
Bot
added
the
needs:compliance
github-actions
Bot
removed
the
needs:compliance
|
Thanks for updating your PR! It now meets our contributing guidelines. 👍 |
![opencode-agent[bot]](https://avatars.githubusercontent.com/in/1549082?s=60&v=4){kind=small}
There was a problem hiding this comment.
The English cli.mdx changes are correct. The new --server / --standalone rows match the flag definitions in packages/cli/src/commands/commands.ts word for word, and run takes --server with no --attach. This is docs only, so there was nothing to run. No public API changes.
- The translated pages are only partly fixed. The 17 locale
cli.mdxfiles had theirattachsection removed. But they still showopencode run --attach http://localhost:4096and an--attachrow in therunflag table (around lines 274 and 290). None of them got the root--server/--standalonerows. A reader of a translated page still gets a flag that doesn't exist. Please make the samerunand root-table edits in each locale, or remove the locale files from this pull request and leave them for a follow-up, so the description matches what changes. web.mdxstill mentionsopencode attach. Its "Attaching a Terminal" section, in English and all 17 locales, still says to runopencode attach http://localhost:4096. It could be switched toopencode --server <url>here or in a follow-up. Otherwise the docs still point at the missing command.
#58016 also removes the English attach section, so the two will conflict there.
Related: #57957
|
Closing this in favor of #58016, which was opened earlier and does the same removal on the English page, including moving The parts of this PR that #58016 does not cover moved to #58207: the same removal for the 17 translated |
Issue for this PR
Part of #57957 (the
attachrow). It should not close the issue: six other command sections in that checklist are still stale.Type of change
What does this PR do?
opencode attachis not a v2 command. It exits 1 and prints the root usage, because the word is read as the project directory. Connecting to a server is the root--serverflag now, and the flag table never documented it.So the
attachsection is removed fromcli.mdxand every locale, the same way the removedagentcommand was cleaned up in #57419.--serverand--standaloneare added to the root flag table, with the descriptions frompackages/cli/src/commands/commands.ts. Therunsection is fixed in the same pass, because its example and flag row still passed--attach.The rest of the checklist is untouched. Whether each remaining section should be dropped or rewritten is your call, and one PR doing all seven would be harder to review.
How did you verify your code works?
Against a source build of
dev(cdf1c200a6), frompackages/cli:bun run src/index.ts --helplists--serverand--standalonewith the exact descriptions now in the table.bun run src/index.ts run --helphas--serverand no--attach.bun run src/index.ts attach http://localhost:4096exits 1 with the root usage.cli.mdxfiles still have balanced code fences, and the deleted block ends right before### authin every locale. Locale diffs are deletions only (0 insertions), so no encoding or line-ending churn.prettieroutput forcli.mdxis byte-identical to the file.Screenshots / recordings
Not a UI change.
Checklist
Added by the opencode bot (AI-generated).
Related: #57957