summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authoradamdottv <[email protected]>2025-06-18 13:56:46 -0500
committeradamdottv <[email protected]>2025-06-18 13:56:51 -0500
commitbd46cf0f868293b501874c1f04632ced3bec7b81 (patch)
treebcd5ed78fc41bcf73c0ffd76086bf10c34ed700b /README.md
parentd4157d9a9603c099e650af4f6c369a56d3878179 (diff)
downloadopencode-bd46cf0f868293b501874c1f04632ced3bec7b81.tar.gz
opencode-bd46cf0f868293b501874c1f04632ced3bec7b81.zip
feat(tui): configurable keybinds and mouse scroll
Diffstat (limited to 'README.md')
-rw-r--r--README.md44
1 files changed, 42 insertions, 2 deletions
diff --git a/README.md b/README.md
index 5fa27d913..09ddb2675 100644
--- a/README.md
+++ b/README.md
@@ -71,8 +71,49 @@ theme = "opencode"
provider = "anthropic"
model = "claude-sonnet-4-20250514"
autoupdate = true
+
+keybinds.leader = "ctrl+x"
+keybinds.session_new = "<leader>n"
+keybinds.editor_open = "<leader>e"
+```
+
+#### Keybinds
+
+You can configure the keybinds in the global config file. (Note: values listed below are the defaults.)
+
+```toml
+# ~/.config/opencode/config
+keybinds.leader = "ctrl+x"
+keybinds.help = "<leader>h"
+keybinds.editor_open = "<leader>e"
+keybinds.session_new = "<leader>n"
+keybinds.session_list = "<leader>l"
+keybinds.session_share = "<leader>s"
+keybinds.session_interrupt = "esc"
+keybinds.session_compact = "<leader>c"
+keybinds.tool_details = "<leader>d"
+keybinds.model_list = "<leader>m"
+keybinds.theme_list = "<leader>t"
+keybinds.project_init = "<leader>i"
+keybinds.input_clear = "ctrl+c"
+keybinds.input_paste = "ctrl+v"
+keybinds.input_submit = "enter"
+keybinds.input_newline = "shift+enter"
+keybinds.history_previous = "up"
+keybinds.history_next = "down"
+keybinds.messages_page_up = "pgup"
+keybinds.messages_page_down = "pgdown"
+keybinds.messages_half_page_up = "ctrl+alt+u"
+keybinds.messages_half_page_down = "ctrl+alt+d"
+keybinds.messages_previous = "ctrl+alt+k"
+keybinds.messages_next = "ctrl+alt+j"
+keybinds.messages_first = "ctrl+g"
+keybinds.messages_last = "ctrl+alt+g"
+keybinds.app_exit = "ctrl+c,<leader>q"
```
+#### Models.dev
+
You can also extend the models.dev database with your own providers by mirroring the structure found [here](https://github.com/sst/models.dev/tree/dev/providers/anthropic)
Start with a `provider.toml` file in `~/.config/opencode/providers`
@@ -171,8 +212,7 @@ To run.
```bash
$ bun install
-$ cd packages/opencode
-$ bun run src/index.ts
+$ bun run packages/opencode/src/index.ts
```
### FAQ