summaryrefslogtreecommitdiffhomepage
path: root/packages/web/src
diff options
context:
space:
mode:
authorsonsulee <[email protected]>2025-09-27 02:09:46 +0900
committerGitHub <[email protected]>2025-09-26 13:09:46 -0400
commitf321661b4c2446dd625adcf874d872bad1e90d51 (patch)
tree2ff6939b195f5a43709273ee75aaad193b267fb0 /packages/web/src
parent7ecdc1b5d8c324edfd28a9ce23a7fc6e8b7d520f (diff)
downloadopencode-f321661b4c2446dd625adcf874d872bad1e90d51.tar.gz
opencode-f321661b4c2446dd625adcf874d872bad1e90d51.zip
docs: add TUI configuration options and examples (#2212)
Co-authored-by: GitHub Action <[email protected]> Co-authored-by: Jay <[email protected]>
Diffstat (limited to 'packages/web/src')
-rw-r--r--packages/web/src/content/docs/config.mdx17
-rw-r--r--packages/web/src/content/docs/tui.mdx19
2 files changed, 36 insertions, 0 deletions
diff --git a/packages/web/src/content/docs/config.mdx b/packages/web/src/content/docs/config.mdx
index 2fa26675e..907389e05 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 743702eaa..edd0013de 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`)