codock.nvim

KO | EN

gitlite — search

#hacktoberfest #react #ai #go #golang #android #rust #nodejs #windows #kubernetes #awesome-list #security #mcp #open-source

(★ 15)

A Neovim plugin that opens a terminal with the Coding Agent (crush, opencode, claude, gemini-cli, etc.) in a vertical split.

codock.nvim Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# codock.nvim

English | [中文](./README.zh-CN.md)

A Neovim plugin that opens a terminal with Coding Agent CLI tools (crush, opencode, claude, gemini-cli, etc.) in a vertical split.

![Preview](https://raw.githubusercontent.com/gitsang/codock.nvim/main/resources/Preview.gif)

## 1. Installation

Using [lazy.nvim](https://github.com/folke/lazy.nvim):

```lua
{
  'gitsang/codock.nvim',
  opts = {
    width = 80, -- Width of the vertical split
    codock_cmd = "opencode", -- Command to run in the terminal (crush, opencode, claude, gemini-cli, etc.)
    copy_to_clipboard = false, -- Copy to system clipboard
    actions = {},
  },
  cmd = { "Codock", "CodockFilePosPaste", "CodockFilePosYank", "CodockActions" },
  keys = {
    { "<leader>CCO", "<cmd>Codock opencode<cr>", desc = "Toggle Codock Opencode", mode = { "n", "v" } },
    { "<leader>CCC", "<cmd>Codock claude<cr>", desc = "Toggle Codock Claude", mode = { "n", "v" } },
    { "<leader>CCX", "<cmd>Codock omx --madmax --xhigh<cr>", desc = "Toggle Codock Codex", mode = { "n", "v" } },
    { "<leader>CY", ":'<,'>CodockFilePosYank @<cr>", desc = "Copy file position", mode = { "n", "v" } },
    { "<leader>CP", ":'<,'>CodockFilePosPaste @<cr>", desc = "Copy and paste file position", mode = { "n", "v" } },
    { "<leader>CA", ":'<,'>CodockActions<cr>", desc = "Run Codock actions", mode = { "n", "v" } },
  },
}
```

## 2. Usage

After installation, you can run the following commands:

### 2.1 Codock Command

Run the `:Codock` command to open a terminal in a vertical split running the configured AI CLI command.

You can also specify a different CLI tool as an argument:

- `:Codock` - Open the default CLI tool configured in `codock_cmd`
- `:Codock claude` - Open claude
- `:Codock opencode` - Open opencode
- `:Codock gemini-cli` - Open gemini-cli

### 2.2 CodockFilePosPaste and CodockFilePosYank Commands

- `:CodockFilePosPaste [prefix]` copies the relative file path and line/column information, then sends it to the AI CLI tool. For example, `:CodockFilePosPaste @` copies and sends `@path/to/file.lua:L1`.
- `:CodockFilePosYank [prefix]` only copies the relative file path and line/column information. For example, `:CodockFilePosYank @` copies `@path/to/file.lua:L1`.
- The optional prefix defaults to an empty string.
- `:CodockFilePos [prefix]` remains as a backward-compatible alias for `:CodockFilePosPaste [prefix]`.

### 2.3 CodockActions Command

The `:CodockActions` command opens a popup selector containing the default and custom actions. The default actions include yanking and pasting file positions; these request an optional prefix through `vim.ui.input()`.

You can find how to define prompt and executable actions in [Custom Actions Tutorial](docs/actions.md).

## 3. Supported AI CLI Tools

This plugin supports various AI CLI tools:

- `crush` - [Crush CLI](https://github.com/charmbracelet/crush)
- `opencode` - OpenCode
- `claude` - Claude Code
- `gemini-cli` - Gemini CLI

Simply set the `codock_cmd` option to your preferred AI CLI tool.

codock.nvim

codock.nvim Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

codock.nvim

codock.nvim Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README