neovimcraft

plugins configs about

3,600

140

CREATED

2025-07-12

UPDATED

2026-06-24

opencode.nvim — Neovim 🤝 OpenCode

Neovim plugin that integrates OpenCode to keep you in your familiar flow.

https://github.com/user-attachments/assets/e85e021c-fa8f-466e-830c-c667b28f611e

⭐ Motivation

AI works best at small, focused scopes — as a pair programmer with the human driving. You stay in control, craft the code that matters, and keep your skills sharp. opencode.nvim just provides the context and connection to make that pairing seamless.

Rather than introduce yet another interaction model, opencode.nvim leverages OpenCode's existing TUI and API via standard Neovim interfaces. You keep your environment, your config, your flow.

For me, the best tools are the ones that "just work." opencode.nvim is designed to be one of them.

✨ Features

Connect to any OpenCode server, or start an integrated instance
Inject editor context (cursor, selection, buffer, etc.)
Input prompts with completions and highlights
Select from built-in and custom prompts
Execute OpenCode commands
Accept/reject and reload OpenCode edits
Handle OpenCode events as autocmds
Simple, sensible, Vim-y defaults and interfaces

📦 Setup

vim.pack (recommended)

vim.pack.add({
  {
    src = "https://github.com/nickjvandyke/opencode.nvim",
    version = vim.version.range("*"), -- Latest stable release
  },
})

---@type opencode.Opts
vim.g.opencode_opts = {
  -- Your configuration, if any; goto definition on the type for details
}

vim.o.autoread = true -- Required for `vim.g.opencode_opts.events.reload`

-- Recommended/example keymaps
vim.keymap.set({ "n", "x" }, "<leader>oa", function() require("opencode").ask("@this: ") end, { desc = "Ask OpenCode…" })
vim.keymap.set({ "n", "x" }, "<leader>os", function() require("opencode").select() end,       { desc = "Select OpenCode…" })

vim.keymap.set({ "n", "x" }, "go",  function() return require("opencode").operator("@this ") end,        { desc = "Append range to OpenCode", expr = true })
vim.keymap.set("n",          "goo", function() return require("opencode").operator("@this ") .. "_" end, { desc = "Append line to OpenCode", expr = true })

vim.keymap.set("n", "<S-C-u>", function() require("opencode").command("session.half.page.up") end,   { desc = "Scroll OpenCode up" })
vim.keymap.set("n", "<S-C-d>", function() require("opencode").command("session.half.page.down") end, { desc = "Scroll OpenCode down" })

{
  "nickjvandyke/opencode.nvim",
  version = "*", -- Latest stable release
  config = function()
    ---@type opencode.Opts
    vim.g.opencode_opts = {
      -- Your configuration, if any; goto definition on the type for details
    }

    vim.o.autoread = true -- Required for `vim.g.opencode_opts.events.reload`

    -- Recommended/example keymaps
    vim.keymap.set({ "n", "x" }, "<leader>oa", function() require("opencode").ask("@this: ") end, { desc = "Ask OpenCode…" })
    vim.keymap.set({ "n", "x" }, "<leader>os", function() require("opencode").select() end,       { desc = "Select OpenCode…" })

    vim.keymap.set({ "n", "x" }, "go",  function() return require("opencode").operator("@this ") end,        { desc = "Append range to OpenCode", expr = true })
    vim.keymap.set("n",          "goo", function() return require("opencode").operator("@this ") .. "_" end, { desc = "Append line to OpenCode", expr = true })

    vim.keymap.set("n", "<S-C-u>", function() require("opencode").command("session.half.page.up") end,   { desc = "Scroll OpenCode up" })
    vim.keymap.set("n", "<S-C-d>", function() require("opencode").command("session.half.page.down") end, { desc = "Scroll OpenCode down" })
  end,
}

programs.nixvim = {
  extraPlugins = [
    pkgs.vimPlugins.opencode-nvim
  ];
};

Integrations

The below examples are specific, but generalize to other plugins.

require("snacks").setup({
  input = {
    enabled = true, -- Enhances `ask()`
  },
  picker = {
    enabled = true, -- Enhances `select()`
    actions = {
      opencode_send = function(picker) ---@param picker snacks.Picker
        local items = vim.tbl_map(function(item) ---@param item snacks.picker.Item
          return item.file
            and require("opencode").format({ path = item.file, from = item.pos, to = item.end_pos })
            or item.text
        end, picker:selected({ fallback = true }))

        require("opencode").prompt(table.concat(items, ", ") .. " ")
      end,
    },
    win = {
      input = {
        keys = {
          ["<a-a>"] = { "opencode_send", mode = { "n", "i" } },
        },
      },
    },
  },
})

-- Configure blink.cmp to show completions from opencode.nvim's in-process LSP.
-- Only applicable when using snacks.input.
require("blink.cmp").setup({
  sources = {
    -- Either enable LSP (and optionally buffer) source globally
    default = { 'lsp', 'buffer' },
    -- Or only for `ask()`
    per_filetype = {
      opencode_ask = { 'lsp', 'buffer' },
    },
    -- Display buffer completions (if included above) when no LSP completions are available
    providers = { lsp = { fallbacks = {} } },
  },
})

require("lualine").setup({
  sections = {
    lualine_z = {
      {
        -- Show the currently connected server and its status
        require("opencode").statusline,
      },
    }
  }
})

[!TIP] Run :checkhealth opencode after setup.

⚙️ Configuration

opencode.nvim provides a rich and reliable default experience — see all available options and their defaults here.

Contexts

opencode.nvim replaces placeholders in prompts with the corresponding context:

Placeholder	Context
`@this`	Range or selection if any, else cursor position
`@buffer`	Current buffer
`@buffers`	Open buffers
`@diagnostics`	Diagnostics within the range or selection if any, else in the current buffer
`@marks`	Global marks
`@quickfix`	Quickfix list
`@visible`	Visible text

[!TIP] OpenCode reads referenced files from disk — save your changes!

Prompts

Select prompts to review, explain, and improve your code:

Name	Prompt
`diagnostics`	Explain `@diagnostics`
`document`	Add comments documenting `@this`
`explain`	Explain `@this` and its context
`fix`	Fix `@diagnostics`
`implement`	Implement `@this`
`optimize`	Optimize `@this` for performance and readability
`review`	Review `@this` for correctness and readability
`test`	Add tests for `@this`

Server

Run opencode locally however you like and opencode.nvim will find them! Or point vim.g.opencode_opts.server.url to a specific server, including remotes.

[!IMPORTANT] You must run opencode with the --port flag to expose its server.

If opencode.nvim can't find a running opencode, it starts one via vim.g.opencode_opts.server.start, defaulting to term://opencode --port.

local opencode_cmd = 'opencode --port'
---@type snacks.terminal.Opts
local snacks_terminal_opts = {
  win = {
    position = 'right',
    enter = false,
  },
}

---@type opencode.Opts
vim.g.opencode_opts = {
  server = {
    start = function()
      require('snacks.terminal').open(opencode_cmd, snacks_terminal_opts)
    end,
  },
}

-- Can also leverage toggle functionality.
-- If you use <leader> here, remove 't' — otherwise Neovim will add input delay to your <leader> when typing in the terminal to watch for the mapping.
vim.keymap.set({ 'n', 't' }, '<C-.>', function()
  require('snacks.terminal').toggle(opencode_cmd, snacks_terminal_opts)
end, { desc = 'Toggle OpenCode' })

-- Optionally show upon submitting prompt
vim.api.nvim_create_autocmd('User', {
  pattern = { 'OpencodeEvent:tui.command.execute' },
  callback = function(args)
    ---@type opencode.server.Event
    local event = args.data.event
    if event.properties.command == 'prompt.submit' then
      local win = require('snacks.terminal').get(opencode_cmd, { create = false })
      if win then
        win:show()
      end
    end
  end,
})

🚀 Usage

Ask — `require("opencode").ask()`

Input a prompt for OpenCode.

Passes the text to prompt().
Press <Up> to browse recent asks.
Highlights and completes contexts and OpenCode subagents.
- Press <Tab> to trigger built-in completion.
- Provided by in-process LSP when using snacks.input.

Select — `require("opencode").select()`

Select from all opencode.nvim functionality.

Prompts
Commands
Servers

Highlights and previews items when using snacks.picker.

Prompt — `require("opencode").prompt()`

Prompt OpenCode.

Injects configured contexts.
Trailing space appends; trailing "..." opens in ask().
OpenCode will interpret references to files or subagents.

Operator — `require("opencode").operator()`

Wraps prompt as an operator, supporting ranges and dot-repeat.

Command — `require("opencode").command()`

Command OpenCode:

Command	Description
`agent.cycle`	Cycle selected agent
`prompt.clear`	Clear current prompt
`prompt.submit`	Submit current prompt
`session.compact`	Compact current session
`session.first`	Jump to first message in session
`session.half.page.up`	Scroll messages up half a page
`session.half.page.down`	Scroll messages down half a page
`session.interrupt`	Interrupt current session
`session.last`	Jump to last message in current session
`session.new`	Start new session
`session.page.up`	Scroll messages up one page
`session.page.down`	Scroll messages down one page
`session.select`	Select session
`session.share`	Share current session
`session.redo`	Redo last undone action in current session
`session.undo`	Undo last action in current session

👀 Events

opencode.nvim forwards OpenCode's Server-Sent-Events as an OpencodeEvent autocmd:

-- Handle OpenCode events
vim.api.nvim_create_autocmd("User", {
  pattern = "OpencodeEvent:*", -- Optionally filter event types
  callback = function(args)
    ---@type opencode.server.Event
    local event = args.data.event
    ---@type string
    local url = args.data.url

    -- See the available event types and their properties
    vim.notify(vim.inspect(event))
    -- Do something useful
    if event.type == "session.status" then
      vim.notify("OpenCode status updated: " .. event.properties.status.type)
    end
  end,
})

Edits

When OpenCode edits a file, opencode.nvim automatically reloads the corresponding buffer.

Permissions

When OpenCode requests a permission, opencode.nvim asks you to approve or deny it.

Edits

For edit requests, opencode.nvim opens the target file in a new tab and uses Neovim's :diffpatch to display the proposed changes side-by-side. See :h 'diffopt' for customization.

Keymap	Function
`da`	Accept the entire edit request
`dr`	Reject the entire edit request
`]c/[c`	Next/prev change
`dp`	Natively accept only the hunk under the cursor, and reject the edit request
`do`	Natively reject only the hunk under the cursor, and reject the edit request
`q`	Close the diff

neovimcraft

neovimcraft

nickjvandyke/opencode.nvim

CREATED

2025-07-12

UPDATED

2026-06-24

opencode.nvim — Neovim 🤝 OpenCode

⭐ Motivation

✨ Features

📦 Setup

Integrations

⚙️ Configuration

Contexts

Prompts

Server

🚀 Usage

Ask — require("opencode").ask()

Select — require("opencode").select()

Prompt — require("opencode").prompt()

Operator — require("opencode").operator()

Command — require("opencode").command()

👀 Events

Edits

Permissions

Edits

Ask — `require("opencode").ask()`

Select — `require("opencode").select()`

Prompt — `require("opencode").prompt()`

Operator — `require("opencode").operator()`

Command — `require("opencode").command()`