| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298 |
- ---
- title: Keybinds
- description: Customize your keybinds.
- ---
- OpenCode has a list of keybinds that you can customize through `tui.json`.
- ```json title="tui.json"
- {
- "$schema": "https://opencode.ai/tui.json",
- "leader_timeout": 2000,
- "keybinds": {
- "leader": "ctrl+x",
- "app_exit": "ctrl+c,ctrl+d,<leader>q",
- "app_debug": "none",
- "app_console": "none",
- "app_heap_snapshot": "none",
- "app_toggle_animations": "none",
- "app_toggle_file_context": "none",
- "app_toggle_diffwrap": "none",
- "app_toggle_paste_summary": "none",
- "app_toggle_session_directory_filter": "none",
- "command_list": "ctrl+p",
- "help_show": "none",
- "docs_open": "none",
- "editor_open": "<leader>e",
- "theme_list": "<leader>t",
- "theme_switch_mode": "none",
- "theme_mode_lock": "none",
- "sidebar_toggle": "<leader>b",
- "scrollbar_toggle": "none",
- "status_view": "<leader>s",
- "session_export": "<leader>x",
- "session_copy": "none",
- "session_new": "<leader>n",
- "session_list": "<leader>l",
- "session_timeline": "<leader>g",
- "session_fork": "none",
- "session_rename": "ctrl+r",
- "session_delete": "ctrl+d",
- "session_share": "none",
- "session_unshare": "none",
- "session_interrupt": "escape",
- "session_compact": "<leader>c",
- "session_toggle_timestamps": "none",
- "session_toggle_generic_tool_output": "none",
- "session_child_first": "<leader>down",
- "session_child_cycle": "right",
- "session_child_cycle_reverse": "left",
- "session_parent": "up",
- "stash_delete": "ctrl+d",
- "model_provider_list": "ctrl+a",
- "model_favorite_toggle": "ctrl+f",
- "model_list": "<leader>m",
- "model_cycle_recent": "f2",
- "model_cycle_recent_reverse": "shift+f2",
- "model_cycle_favorite": "none",
- "model_cycle_favorite_reverse": "none",
- "mcp_list": "none",
- "provider_connect": "none",
- "console_org_switch": "none",
- "agent_list": "<leader>a",
- "agent_cycle": "tab",
- "agent_cycle_reverse": "shift+tab",
- "variant_cycle": "ctrl+t",
- "variant_list": "none",
- "messages_page_up": "pageup,ctrl+alt+b",
- "messages_page_down": "pagedown,ctrl+alt+f",
- "messages_line_up": "ctrl+alt+y",
- "messages_line_down": "ctrl+alt+e",
- "messages_half_page_up": "ctrl+alt+u",
- "messages_half_page_down": "ctrl+alt+d",
- "messages_first": "ctrl+g,home",
- "messages_last": "ctrl+alt+g,end",
- "messages_next": "none",
- "messages_previous": "none",
- "messages_last_user": "none",
- "messages_copy": "<leader>y",
- "messages_undo": "<leader>u",
- "messages_redo": "<leader>r",
- "messages_toggle_conceal": "<leader>h",
- "tool_details": "none",
- "display_thinking": "none",
- "prompt_submit": "none",
- "prompt_editor_context_clear": "none",
- "prompt_skills": "none",
- "prompt_stash": "none",
- "prompt_stash_pop": "none",
- "prompt_stash_list": "none",
- "workspace_set": "none",
- "input_clear": "ctrl+c",
- "input_paste": {
- "key": "ctrl+v",
- "preventDefault": false
- },
- "input_submit": "return",
- "input_newline": "shift+return,ctrl+return,alt+return,ctrl+j",
- "input_move_left": "left,ctrl+b",
- "input_move_right": "right,ctrl+f",
- "input_move_up": "up",
- "input_move_down": "down",
- "input_select_left": "shift+left",
- "input_select_right": "shift+right",
- "input_select_up": "shift+up",
- "input_select_down": "shift+down",
- "input_line_home": "ctrl+a",
- "input_line_end": "ctrl+e",
- "input_select_line_home": "ctrl+shift+a",
- "input_select_line_end": "ctrl+shift+e",
- "input_visual_line_home": "alt+a",
- "input_visual_line_end": "alt+e",
- "input_select_visual_line_home": "alt+shift+a",
- "input_select_visual_line_end": "alt+shift+e",
- "input_buffer_home": "home",
- "input_buffer_end": "end",
- "input_select_buffer_home": "shift+home",
- "input_select_buffer_end": "shift+end",
- "input_delete_line": "ctrl+shift+d",
- "input_delete_to_line_end": "ctrl+k",
- "input_delete_to_line_start": "ctrl+u",
- "input_backspace": "backspace,shift+backspace",
- "input_delete": "ctrl+d,delete,shift+delete",
- "input_undo": "ctrl+-,super+z",
- "input_redo": "ctrl+.,super+shift+z",
- "input_word_forward": "alt+f,alt+right,ctrl+right",
- "input_word_backward": "alt+b,alt+left,ctrl+left",
- "input_select_word_forward": "alt+shift+f,alt+shift+right",
- "input_select_word_backward": "alt+shift+b,alt+shift+left",
- "input_delete_word_forward": "alt+d,alt+delete,ctrl+delete",
- "input_delete_word_backward": "ctrl+w,ctrl+backspace,alt+backspace",
- "input_select_all": "super+a",
- "history_previous": "up",
- "history_next": "down",
- "dialog.select.prev": "up,ctrl+p",
- "dialog.select.next": "down,ctrl+n",
- "dialog.select.page_up": "pageup",
- "dialog.select.page_down": "pagedown",
- "dialog.select.home": "home",
- "dialog.select.end": "end",
- "dialog.select.submit": "return",
- "dialog.prompt.submit": "return",
- "dialog.mcp.toggle": "space",
- "prompt.autocomplete.prev": "up,ctrl+p",
- "prompt.autocomplete.next": "down,ctrl+n",
- "prompt.autocomplete.hide": "escape",
- "prompt.autocomplete.select": "return",
- "prompt.autocomplete.complete": "tab",
- "permission.prompt.fullscreen": "ctrl+f",
- "plugins.toggle": "space",
- "dialog.plugins.install": "shift+i",
- "terminal_suspend": "ctrl+z",
- "terminal_title_toggle": "none",
- "tips_toggle": "<leader>h",
- "plugin_manager": "none",
- "plugin_install": "none",
- "which_key_toggle": "ctrl+alt+k",
- "which_key_layout_toggle": "ctrl+alt+shift+k",
- "which_key_pending_toggle": "ctrl+alt+shift+p",
- "which_key_group_previous": "ctrl+alt+left,ctrl+alt+[",
- "which_key_group_next": "ctrl+alt+right,ctrl+alt+]",
- "which_key_scroll_up": "ctrl+alt+up,ctrl+alt+p",
- "which_key_scroll_down": "ctrl+alt+down,ctrl+alt+n",
- "which_key_page_up": "ctrl+alt+pageup",
- "which_key_page_down": "ctrl+alt+pagedown",
- "which_key_home": "ctrl+alt+home",
- "which_key_end": "ctrl+alt+end"
- }
- }
- ```
- :::note
- On Windows, the defaults for `input_undo` and `terminal_suspend` are different:
- - `input_undo` defaults to `ctrl+z,ctrl+-,super+z` when it is not explicitly configured. The `ctrl+z` binding is added because Windows terminals do not support POSIX suspend.
- - `terminal_suspend` is forced to `none` because native Windows terminals do not support POSIX suspend.
- :::
- ---
- ## Leader Key
- OpenCode uses a `leader` key for many keybinds. This avoids conflicts in your terminal.
- By default, `ctrl+x` is the leader key and many actions require you to first press the leader key and then the shortcut. For example, to start a new session you first press `ctrl+x` and then press `n`.
- You don't need to use a leader key for your keybinds but we recommend doing so.
- Some navigation keybinds intentionally do not use the leader key by default. For subagent sessions, the defaults are `session_child_first` = `<leader>down`, `session_child_cycle` = `right`, `session_child_cycle_reverse` = `left`, and `session_parent` = `up`.
- `leader_timeout` controls how long OpenCode waits for the next key after the leader key. It defaults to `2000` milliseconds.
- ---
- ## Binding Values
- A string can contain one shortcut or multiple comma-separated shortcuts. You can also use an array for multiple shortcuts.
- For advanced cases, use an object with `key`, `event`, `preventDefault`, or `fallthrough`.
- ```json title="tui.json"
- {
- "$schema": "https://opencode.ai/tui.json",
- "keybinds": {
- "messages_copy": ["<leader>y", "ctrl+shift+c"],
- "input_paste": {
- "key": "ctrl+v",
- "preventDefault": false
- }
- }
- }
- ```
- ---
- ## Disable Keybind
- You can disable a keybind by adding the key to `tui.json` with a value of `"none"` or `false`.
- ```json title="tui.json"
- {
- "$schema": "https://opencode.ai/tui.json",
- "keybinds": {
- "session_compact": "none"
- }
- }
- ```
- ---
- ## Desktop Prompt Shortcuts
- The OpenCode desktop app prompt input supports common Readline/Emacs-style shortcuts for editing text. These are built-in and currently not configurable via `opencode.json`.
- | Shortcut | Action |
- | -------- | ---------------------------------------- |
- | `ctrl+a` | Move to start of current line |
- | `ctrl+e` | Move to end of current line |
- | `ctrl+b` | Move cursor back one character |
- | `ctrl+f` | Move cursor forward one character |
- | `alt+b` | Move cursor back one word |
- | `alt+f` | Move cursor forward one word |
- | `ctrl+d` | Delete character under cursor |
- | `ctrl+k` | Kill to end of line |
- | `ctrl+u` | Kill to start of line |
- | `ctrl+w` | Kill previous word |
- | `alt+d` | Kill next word |
- | `ctrl+t` | Transpose characters |
- | `ctrl+g` | Cancel popovers / abort running response |
- ---
- ## Shift+Enter
- Some terminals don't send modifier keys with Enter by default. You may need to configure your terminal to send `Shift+Enter` as an escape sequence.
- ### Windows Terminal
- Open your `settings.json` at:
- ```
- %LOCALAPPDATA%\Packages\Microsoft.WindowsTerminal_8wekyb3d8bbwe\LocalState\settings.json
- ```
- Add this to the root-level `actions` array:
- ```json
- "actions": [
- {
- "command": {
- "action": "sendInput",
- "input": "\u001b[13;2u"
- },
- "id": "User.sendInput.ShiftEnterCustom"
- }
- ]
- ```
- Add this to the root-level `keybindings` array:
- ```json
- "keybindings": [
- {
- "keys": "shift+enter",
- "id": "User.sendInput.ShiftEnterCustom"
- }
- ]
- ```
- Save the file and restart Windows Terminal or open a new tab.
|