Skip to content

Commit b9395af

Browse files
3dyuvalsudo-tee
3dyuval
authored and
sudo-tee
committed
fix readme missing references and typos
1 parent b7ae89c commit b9395af

1 file changed

Lines changed: 16 additions & 15 deletions

File tree

‎README.md‎

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -94,13 +94,13 @@ Install the plugin with your favorite package manager. See the [Configuration](#
9494
-- Default configuration with all available options
9595
require('opencode').setup({
9696
preferred_picker = nil, -- 'telescope', 'fzf', 'mini.pick', 'snacks', if nil, it will use the best available picker
97-
prefered_completion = nil, -- 'blip', 'nvim-cmp','vim_complete' if nil, it will use the best available completion
97+
preferred_completion = nil, -- 'blink', 'nvim-cmp','vim_complete' if nil, it will use the best available completion
9898
default_global_keymaps = true, -- If false, disables all default global keymaps
9999
default_mode = 'build', -- 'build' or 'plan' or any custom configured. @see [OpenCode Agents](https://opencode.ai/docs/modes/)
100100
config_file_path = nil, -- Path to opencode configuration file if different from the default `~/.config/opencode/config.json` or `~/.config/opencode/opencode.json`
101101
keymap = {
102102
global = {
103-
toggle = '<leader>oa', -- Open opencode. Close if opened
103+
toggle = '<leader>og', -- Open opencode. Close if opened
104104
open_input = '<leader>oi', -- Opens and focuses on input window on insert mode
105105
open_input_new_session = '<leader>oI', -- Opens and focuses on input window on insert mode. Creates a new session
106106
open_output = '<leader>oo', -- Opens and focuses on output window
@@ -120,20 +120,21 @@ require('opencode').setup({
120120
},
121121
window = {
122122
submit = '<cr>', -- Submit prompt (normal mode)
123-
submit_insert = '<C-s>', -- Submit prompt (insert mode)
123+
submit_insert = '<cr>', -- Submit prompt (insert mode)
124124
close = '<esc>', -- Close UI windows
125125
stop = '<C-c>', -- Stop opencode while it is running
126126
next_message = ']]', -- Navigate to next message in the conversation
127127
prev_message = '[[', -- Navigate to previous message in the conversation
128-
mention_file = '@', -- Pick a file and add to context. See File Mentions section
129-
slash_command = '/', -- Pick a command to run in the input window
128+
mention = '@', -- Insert mention (file/agent)
129+
mention_file = '~', -- Pick a file and add to context. See File Mentions section
130+
slash_commands = '/', -- Pick a command to run in the input window
130131
toggle_pane = '<tab>', -- Toggle between input and output panes
131132
prev_prompt_history = '<up>', -- Navigate to previous prompt in history
132133
next_prompt_history = '<down>', -- Navigate to next prompt in history
133134
switch_mode = '<M-m>', -- Switch between modes (build/plan)
134135
focus_input = '<C-i>', -- Focus on input window and enter insert mode at the end of the input from the output window
135136
select_child_session = '<leader>oS', -- Select and load a child session
136-
debug_messages = '<leader>oD', -- Open raw message in new buffer for debugging
137+
debug_message = '<leader>oD', -- Open raw message in new buffer for debugging
137138
debug_output = '<leader>oO', -- Open raw output in new buffer for debugging
138139
},
139140
},
@@ -273,29 +274,29 @@ The plugin provides the following actions that can be triggered via keymaps, com
273274
| Open input window (current session) | `<leader>oi` | `:OpencodeOpenInput` | `require('opencode.api').open_input()` |
274275
| Open input window (new session) | `<leader>oI` | `:OpencodeOpenInputNewSession` | `require('opencode.api').open_input_new_session()` |
275276
| Open output window | `<leader>oo` | `:OpencodeOpenOutput` | `require('opencode.api').open_output()` |
276-
| Create and switch to a named session | - | `:OpencodeNewSession` | `require('opencode.api').new_session()` |
277+
| Create and switch to a named session | - | `:OpencodeCreateNewSession` | `require('opencode.api').new_session()` **Not implemented yet** |
277278
| Toggle focus opencode / last window | `<leader>ot` | `:OpencodeToggleFocus` | `require('opencode.api').toggle_focus()` |
278279
| Close UI windows | `<leader>oq` | `:OpencodeClose` | `require('opencode.api').close()` |
279280
| Select and load session | `<leader>os` | `:OpencodeSelectSession` | `require('opencode.api').select_session()` |
280-
| **Select and load child session** | `<leader>ocj` | `:OpencodeSelectChildSession` | `require('opencode.api').select_child_session()` |
281+
| **Select and load child session** | `<leader>oS` | `:OpencodeSelectChildSession` | `require('opencode.api').select_child_session()` |
281282
| Configure provider and model | `<leader>op` | `:OpencodeConfigureProvider` | `require('opencode.api').configure_provider()` |
282283
| Open diff view of changes | `<leader>od` | `:OpencodeDiff` | `require('opencode.api').diff_open()` |
283284
| Navigate to next file diff | `<leader>o]` | `:OpencodeDiffNext` | `require('opencode.api').diff_next()` |
284285
| Navigate to previous file diff | `<leader>o[` | `:OpencodeDiffPrev` | `require('opencode.api').diff_prev()` |
285286
| Close diff view tab | `<leader>oc` | `:OpencodeDiffClose` | `require('opencode.api').diff_close()` |
286287
| Revert all file changes since last prompt | `<leader>ora` | `:OpencodeRevertAllLastPrompt` | `require('opencode.api').diff_revert_all_last_prompt()` |
287-
| Revert current file changes last prompt | `<leader>ort` | `:OpencodeRevertAllLastPrompt` | `require('opencode.api').diff_revert_this_last_prompt()` |
288-
| Revert all file changes since last session | `<leader>orA` | `:OpencodeRevertAllLastSession` | `require('opencode.api').diff_revert_all_last_prompt()` |
289-
| Revert current file changes last session | `<leader>orT` | `:OpencodeRevertAllLastSession` | `require('opencode.api').diff_revert_this_last_prompt()` |
288+
| Revert current file changes last prompt | `<leader>ort` | `:OpencodeRevertThisLastPrompt` | `require('opencode.api').diff_revert_this_last_prompt()` |
289+
| Revert all file changes since last session | `<leader>orA` | `:OpencodeRevertAllSession` | `require('opencode.api').diff_revert_all_session()` **Not implemented yet** |
290+
| Revert current file changes last session | `<leader>orT` | `:OpencodeRevertThisSession` | `require('opencode.api').diff_revert_this_session()` **Not implemented yet** |
290291
| Initialize/update AGENTS.md file | - | `:OpencodeInit` | `require('opencode.api').initialize()` |
291292
| Run prompt (continue session) [Run opts](#run-opts) | - | `:OpencodeRun <prompt> <opts>` | `require('opencode.api').run("prompt", opts)` |
292293
| Run prompt (new session) [Run opts](#run-opts) | - | `:OpencodeRunNewSession <prompt> <opts>` | `require('opencode.api').run_new_session("prompt", opts)` |
293294
| Stop opencode while it is running | `<C-c>` | `:OpencodeStop` | `require('opencode.api').stop()` |
294-
| Set mode to Build | - | `:OpencodeAgentBuild` | `require('opencode.api').mode_build()` |
295-
| Set mode to Plan | - | `:OpencodeAgentPlan` | `require('opencode.api').mode_plan()` |
295+
| Set mode to Build | - | `:OpencodeAgentBuild` | `require('opencode.api').agent_build()` |
296+
| Set mode to Plan | - | `:OpencodeAgentPlan` | `require('opencode.api').agent_plan()` |
296297
| Select and switch mode/agent | - | `:OpencodeAgentSelect` | `require('opencode.api').select_agent()` |
297-
| Display list of availale mcp servers | - | `:OpencodeMCP` | `require('opencode.api').list_mcp_servers()` |
298-
| Run user commands | - | `:RunUserCommand` | `require('opencode.api').run_user_command()` |
298+
| Display list of availale mcp servers | - | `:OpencodeMCP` | `require('opencode.api').mcp()` |
299+
| Run user commands | - | `:OpencodeRunUserCommand` | `require('opencode.api').run_user_command()` |
299300
| Insert mention (file/ agent) | `@` | - | - |
300301
| [Pick a file and add to context](#file-mentions) | `~` | - | - |
301302
| Navigate to next message | `]]` | - | - |

0 commit comments

Comments
 (0)