From f321661b4c2446dd625adcf874d872bad1e90d51 Mon Sep 17 00:00:00 2001 From: sonsulee <127682098+sonsulee@users.noreply.github.com> Date: Sat, 27 Sep 2025 02:09:46 +0900 Subject: [PATCH] docs: add TUI configuration options and examples (#2212) Co-authored-by: GitHub Action Co-authored-by: Jay --- packages/web/src/content/docs/config.mdx | 17 +++++++++++++++++ packages/web/src/content/docs/tui.mdx | 19 +++++++++++++++++++ 2 files changed, 36 insertions(+) diff --git a/packages/web/src/content/docs/config.mdx b/packages/web/src/content/docs/config.mdx index 2fa26675..907389e0 100644 --- a/packages/web/src/content/docs/config.mdx +++ b/packages/web/src/content/docs/config.mdx @@ -204,6 +204,23 @@ opencode will automatically download any new updates when it starts up. You can --- +### TUI + +You can configure TUI-specific settings through the `tui` option. + +```json title="opencode.json" +{ + "$schema": "https://opencode.ai/config.json", + "tui": { + "scroll_speed": 3 + } +} +``` + +[Learn more about using the TUI here](/docs/tui). + +--- + ### Formatters You can configure code formatters through the `formatter` option. diff --git a/packages/web/src/content/docs/tui.mdx b/packages/web/src/content/docs/tui.mdx index 743702ea..edd0013d 100644 --- a/packages/web/src/content/docs/tui.mdx +++ b/packages/web/src/content/docs/tui.mdx @@ -325,3 +325,22 @@ Some editors like VS Code need to be started with the `--wait` flag. ::: Some editors need command-line arguments to run in blocking mode. The `--wait` flag makes the editor process block until closed. + +--- + +## Configure + +You can customize TUI behavior through your opencode config file. + +```json title="opencode.json" +{ + "$schema": "https://opencode.ai/config.json", + "tui": { + "scroll_speed": 3 + } +} +``` + +### Options + +- `scroll_speed` - Controls how fast the TUI scrolls when using scroll commands (default: `2`, minimum: `1`)