opencode.nvim

When OpenCode requests a file edit, opencode.nvim opens the target file in a new tab using Neovim's :diffpatch to show changes side-by-side.

Keymaps for managing edits:

You can install opencode.nvim using vim.pack (recommended), lazy.nvim, or nixvim.

Important: After installation, run :checkhealth opencode to verify your setup.

-- Using vim.pack
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
}

opencode.nvim connects to an OpenCode server. You can point to a specific server via vim.g.opencode_opts.server.url.

Requirements:

• You must run the opencode binary with the --port flag to expose its server.

Automatic Startup: If no server is found, opencode.nvim can start one automatically using vim.g.opencode_opts.server.start. By default, it uses term://opencode --port.

Display the currently connected OpenCode server and its status in your statusline using lualine.nvim.

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

To show completions from opencode.nvim's in-process LSP within the Ask interface, configure blink.cmp to include the lsp source for the opencode_ask filetype. This requires snacks.input to be enabled.

-- Configure blink.cmp to show completions in Ask 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 = {} } },
  },
})

Use ask() to input a prompt for OpenCode. This method:

• Passes the text to Prompt.
• Allows browsing recent asks with <Up>.
• Supports highlighting and completing contexts and OpenCode subagents using <Tab> (requires snacks.input).

require("opencode").ask()

The plugin forwards connected OpenCode Server-Sent-Events as OpencodeEvent user autocmds. You can filter these by pattern (e.g., OpencodeEvent:*) to react to session status updates or other events.

Data provided in args.data includes:

• event: An opencode.server.Event object.
• url: The event URL.

-- 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,
})

Use operator() to wrap prompt() as an operator. This enables support for text ranges and dot-repeat functionality.

require("opencode").operator()

Use prompt() to send a prompt to OpenCode. This method:

• Injects configured contexts.
• Appends a trailing space if you add one.
• Opens in ask() mode if the prompt ends with ....
• Interprets references to files or subagents.

require("opencode").prompt()

Use select() to open a picker (requires snacks.picker) that allows you to select from all opencode.nvim functionality, including:

• Prompts
• Commands
• Servers

require("opencode").select()