Files
opencode.nvim/README.md
T
2026-06-11 22:37:38 +02:00

1.9 KiB

opencode.nvim

Neovim plugin that toggles an opencode terminal in a right-side split.

The terminal buffer is kept alive when hidden, so your opencode session remains available across toggles.

Requirements

  • Neovim 0.10 or newer
  • The opencode CLI installed and available on $PATH

This plugin does not install or bundle opencode; it only starts the CLI in a Neovim terminal. Use of opencode is subject to that project's own license and terms.

Installation

Install with your plugin manager of choice.

Using lazy.nvim:

{
  "agj/opencode.nvim",
  opts = {
    width = 0.3,
  },
}

Using vim-plug:

Plug 'agj/opencode.nvim'
require("opencode").setup()

Usage

Run:

:OpenCodeToggle

The command opens opencode in a right-side terminal window sized to 30% of the screen width by default. Running the command again closes only the window; the terminal buffer and opencode session stay alive. Run :OpenCodeToggle again to show the same session.

Configuration

require("opencode").setup({
  width = 0.3,
})

width is the fraction of the screen width used by the terminal window. The default is 0.3. It must be greater than 0 and less than or equal to 1.

Help

After installing the plugin, run:

:help opencode.nvim

If your plugin manager does not generate helptags automatically, run:

:helptags ALL

License

opencode.nvim is free software released under the GNU General Public License, version 3 only. See LICENSE for the full license text.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Trademark Notice

opencode.nvim is an independent Neovim plugin and is not affiliated with, endorsed by, or sponsored by the maintainers of opencode or Neovim.