Skip to content

docs: document the full openers config schema #1356

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ChampPABA wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: document the full openers config schema #1356

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6a2cc2f
docs: document the full openers config schema
ChampPABA Jul 14, 2026
2c26e4b
docs: use a neutral flag in the openers args example
ChampPABA Jul 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion docs/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,11 +365,24 @@ Supporting a new tool is configuration, not code. Every tool is one of two launc
{
"openers": {
"zed": { "style": "workspace-file" },
"claude": { "attach_flag": "--dir" }
"claude": {
"attach_flag": "--dir",
"args": ["--dangerously-skip-permissions"]
}
}
}
```
Comment thread
coderabbitai[bot] marked this conversation as resolved.

| Field | Description |
|-------|-------------|
| `style` | `workspace-file` or `attach-dirs`. Required when the row adds a new tool; optional when it adjusts a built-in. |
| `label` | Name shown in the tool picker. Defaults to the id. |
| `command` | Executable to launch. Defaults to the id. |
| `args` | Pre-args passed before the workspace file or the attach pairs — static flags the tool always needs. The built-in `codex` opener ships `["--sandbox", "workspace-write"]` this way. |
| `attach_flag` | `attach-dirs` only: the flag paired with each member path. Defaults to `--add-dir`. |

A row keyed by a built-in id adjusts only the fields it sets; the rest keep their built-in values.

All workset state lives under the global data dir's `worksets/` folder (the saved views plus the generated `<name>.code-workspace` files, regenerated on every open); deleting that folder removes every trace.

---
Expand Down