Skip to content

Commit b642c1d

Browse files
committed
docs: add CLI settings reference
1 parent c8cc984 commit b642c1d

7 files changed

Lines changed: 295 additions & 103 deletions

File tree

‎packages/core/src/plugin/skill/opencode.md‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,13 @@ project-local CLI configuration. Set `OPENCODE_CLI_CONFIG_CONTENT` to merge
4646
inline JSON over the global settings. Most preferences can also be changed from
4747
the TUI by pressing `Ctrl+P` and selecting **Open settings**.
4848

49-
Fetch the full [CLI configuration guide](https://opencode.ai/v2/docs/cli/config)
50-
before editing `cli.json`. It covers terminal-only settings such as themes,
51-
keybindings, terminal plugins, scrolling, attention alerts, diff presentation,
52-
and terminal integration. Do not put these settings in `opencode.json(c)`.
49+
### [Settings](https://opencode.ai/v2/docs/cli/config)
50+
51+
Fetch the full [CLI settings reference](https://opencode.ai/v2/docs/cli/config)
52+
before editing `cli.json`. It documents every terminal-only setting, accepted
53+
values, and examples, including themes, input, sessions, tabs, diffs, alerts,
54+
Mini, keybindings, terminal plugins, and debugging. Do not put these settings
55+
in `opencode.json(c)`.
5356

5457
### [Keybinds](https://opencode.ai/v2/docs/cli/keybinds)
5558

@@ -93,7 +96,7 @@ Common configuration fields include `model`, `default_agent`, `permissions`,
9396
`references`, `formatter`, and `lsp`.
9497

9598
This configuration is distinct from `cli.json`. Use the
96-
[CLI configuration guide](https://opencode.ai/v2/docs/cli/config) for terminal
99+
[CLI settings reference](https://opencode.ai/v2/docs/cli/config) for terminal
97100
preferences, especially themes and keybindings.
98101

99102
Do not guess field names or shapes. Fetch the V2 configuration guide and its

‎services/www/src/docs/content/cli/config.mdx‎

Lines changed: 282 additions & 93 deletions
Large diffs are not rendered by default.

‎services/www/src/docs/content/cli/theme.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ OpenCode includes built-in light and dark themes. Choose a color scheme in setti
88

99
Press `Ctrl+P`, then select **Open settings** to change the theme and color mode.
1010

11-
You can also set them in your global [CLI config](/cli/config):
11+
You can also set them in your global [CLI settings](/cli/config):
1212

1313
```json title="~/.config/opencode/cli.json"
1414
{

‎services/www/src/docs/content/index.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,4 @@ plan that grants you access to the best open source models.
4646

4747
Make OpenCode your own by editing the [OpenCode config](/config), [loading plugins](/plugins), [connecting MCP
4848
servers](/mcp-servers), or [creating commands](/commands). For terminal interface themes and keybindings, see [CLI
49-
configuration](/cli/config).
49+
settings](/cli/config).

‎services/www/src/docs/content/migrate-v1.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -524,7 +524,7 @@ V2 replaces layered V1 `tui.json(c)` files with one global terminal client confi
524524
The terminal client owns this file; the background service does not load it. When `cli.json` is absent, the first V2
525525
terminal client startup migrates supported global `tui.json` settings and persisted preferences while leaving V1 files
526526
unchanged. Project-local client configuration is not migrated because V2 client configuration is global. See
527-
[CLI config](/cli/config) for current client settings.
527+
[CLI settings](/cli/config) for the current client settings reference.
528528

529529
## Plugins
530530

‎services/www/src/docs/content/themes.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ set it directly in your global CLI config:
1515
```
1616

1717
Themes belong to the terminal client. Put theme selection in `cli.json`, not `opencode.json`. See
18-
[CLI config](/cli/config) for the config location and other terminal settings.
18+
[CLI settings](/cli/config) for the config location and other terminal settings.
1919

2020
## Modes
2121

‎services/www/src/docs/lib/navigation.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ export const docsSections: DocsSection[] = [
6969
items: [
7070
{ title: "Intro", slug: "cli" },
7171
{ title: "TUI", slug: "cli/tui" },
72-
{ title: "Config", slug: "cli/config" },
72+
{ title: "Settings", slug: "cli/config" },
7373
{ title: "Web", slug: "cli/web" },
7474
{ title: "Providers", slug: "cli/providers" },
7575
{ title: "Commands", slug: "cli/commands" },

0 commit comments

Comments
 (0)