codex.nvim

Neovim plugin for running the Codex CLI in an embedded terminal.

Primary home: Codeberg
Mirrored on GitHub

Requirements

Neovim >= 0.11.0
codex available on your PATH (or configure launch.cmd)

Caution

You are reading the main branch README. Install and configuration details may differ from tagged releases. The current latest release tag is v0.4.1. For version-accurate instructions, read the README for your target tag from Codeberg releases.

Install

{
  url = "https://codeberg.org/yaadata/codex.nvim.git",
  version = "0.4.1",
  cmd = {
    "Codex",
    "CodexFocus",
    "CodexClose",
    "CodexClearInput",
    "CodexSend",
    "CodexAddBuffer",
    "CodexMentionFile",
    "CodexMentionDirectory",
    "CodexResume",
    "CodexModel",
    "CodexStatus",
    "CodexPermissions",
    "CodexCompact",
    "CodexReview",
    "CodexDiff",
  },
  opts = {},
  config = function(_, opts)
    require("codex").setup(opts)
  end,
}

Configuration

Use this table as your lazy.nvim plugin opts value:

Show default opts table

opts = {
  launch = {
    cmd = "codex",
    args = {},
    env = {},
    auto_start = false,
    cwd = nil,
  },
  log = {
    level = "warn",
    verbose = false,
  },
  terminal = {
    provider = "auto", -- auto | snacks | native
    window = "vsplit", -- vsplit | hsplit | float
    vsplit = {
      side = "right", -- left | right
      size_pct = 40, -- 10-90
    },
    hsplit = {
      side = "bottom", -- top | bottom
      size_pct = 30, -- 10-90
    },
    float = {
      width_pct = 80, -- 10-100
      height_pct = 80, -- 10-100
      border = "rounded",
      title = " Codex ",
      title_pos = "center", -- left | center | right
    },
    auto_close = false, -- close terminal buffer automatically when process exits
    startup = {
      timeout_ms = 2000, -- max time to wait for startup readiness before dropping queued sends
      retry_interval_ms = 50, -- retry interval while waiting for startup readiness
      grace_ms = 700, -- minimum delay after terminal open before first send
    },
    keymaps = {
      toggle = "<C-c>", -- terminal-mode toggle for Codex window
      clear_input = "<M-BS>", -- clear the current terminal input line
      close = false, -- set a string (e.g. "<C-x>") to close Codex session
      nav = {
        left = "<C-h>", -- split windows only; set false to disable
        down = "<C-j>", -- split windows only; set false to disable
        up = "<C-k>", -- split windows only; set false to disable
        right = "<C-l>", -- split windows only; set false to disable
      },
    },
  },
}

Commands

:Codex toggles the Codex terminal
:Codex! force-opens and focuses the Codex terminal
:CodexFocus focuses the terminal (opens it if needed)
:CodexClose closes the active Codex terminal session
:CodexClearInput clears the active Codex terminal input line
:CodexSend sends selected lines with path and range context.
:CodexAddBuffer sends current buffer path as ACP file reference (@path).
:CodexMentionFile [path] sends /mention for a file path, normalized to cwd-relative.
:CodexMentionDirectory [path] sends /mention for a directory path, normalized to cwd-relative and forced to end with a path separator.
:CodexResume[!] resumes in-process or launches codex resume (! uses --last when launching).
:CodexModel sends /model
:CodexStatus sends /status
:CodexPermissions sends /permissions
:CodexCompact sends /compact
:CodexReview [instructions] sends /review.
:CodexDiff sends /diff

For detailed command behavior and component interactions, see docs/command-interactions.md.

When using lazy.nvim with cmd + opts, prefer wiring setup explicitly in config and passing lazy's resolved opts through:

config = function(_, opts)
  require("codex").setup(opts)
end

The cmd list still ensures first-use lazy loading when a :Codex* command is run.

Keymaps

codex.nvim does not register global keymaps in setup(). Define global mappings in your lazy.nvim plugin spec keys:

Show lazy keys table

{
  url = "https://codeberg.org/yaadata/codex.nvim.git",
  version = "0.3.0",
  main = "codex",
  cmd = {
    "Codex",
    "CodexFocus",
    "CodexClose",
    "CodexClearInput",
    "CodexSend",
    "CodexAddBuffer",
    "CodexMentionFile",
    "CodexMentionDirectory",
    "CodexResume",
    "CodexModel",
    "CodexStatus",
    "CodexPermissions",
    "CodexCompact",
    "CodexReview",
    "CodexDiff",
  },
  opts = {},
  config = function(_, opts)
    require("codex").setup(opts)
  end,
  keys = {
    {
      "<leader>ot",
      function()
        require("codex").toggle()
      end,
      desc = "Codex: Toggle terminal",
      mode = { "n", "v" },
    },
    {
      "<leader>os",
      function()
        require("codex").send_buffer()
      end,
      desc = "Codex: Add current buffer",
      mode = "n",
    },
    {
      "<leader>os",
      function()
        require("codex").send_selection()
      end,
      desc = "Codex: Send selection",
      mode = "x",
    },
    {
      "<leader>om",
      function()
        require("codex").mention_file()
      end,
      desc = "Codex: Mention current file",
      mode = { "n", "v" },
    },
    {
      "<leader>oM",
      function()
        require("codex").mention_directory()
      end,
      desc = "Codex: Mention current directory",
      mode = { "n", "v" },
    },
    {
      "<leader>or",
      function()
        require("codex").resume()
      end,
      desc = "Codex: Resume session",
      mode = { "n", "v" },
    },
    {
      "<leader>oi",
      function()
        require("codex").show_status()
      end,
      desc = "Codex: Show status",
      mode = { "n", "v" },
    },
    {
      "<leader>op",
      function()
        require("codex").show_permissions()
      end,
      desc = "Codex: Permissions",
      mode = { "n", "v" },
    },
    {
      "<leader>oc",
      function()
        require("codex").compact()
      end,
      desc = "Codex: Compact context",
      mode = { "n", "v" },
    },
    {
      "<leader>oR",
      function()
        require("codex").review()
      end,
      desc = "Codex: Review changes",
      mode = { "n", "v" },
    },
    {
      "<leader>od",
      function()
        require("codex").show_diff()
      end,
      desc = "Codex: Show diff",
      mode = { "n", "v" },
    },
  },
}

Set vim.g.mapleader before plugin setup so <leader> expands as expected.

Terminal-local keymaps inside the Codex terminal buffer are configured separately via terminal.keymaps:

require("codex").setup({
  log = {
    level = "warn",
    verbose = false,
  },
  terminal = {
    keymaps = {
      toggle = "<C-c>",
      clear_input = "<M-BS>",
      close = "<C-x>",
      nav = {
        left = "<A-h>",
        down = "<A-j>",
        up = "<A-k>",
        right = "<A-l>",
      },
    },
  },
})

terminal.keymaps.clear_input clears the current terminal input line. terminal.keymaps.close triggers an intentional Codex session close. terminal.auto_close controls whether provider windows auto-close only after the terminal process exits. terminal.keymaps.nav is applied only for split windows (vsplit/hsplit). Set terminal.keymaps.nav = false to disable all navigation keymaps, or set individual directions to false.

Lua API

require("codex").setup(opts) initialize plugin config/runtime and register commands.
require("codex").open(focus) open terminal session.
require("codex").close() close active session.
require("codex").toggle() toggle terminal visibility.
require("codex").focus() focus active session.
require("codex").send(text) send raw text.
require("codex").clear_input() clear current prompt input.
require("codex").send_command(slash_cmd) send slash command text.
require("codex").set_model() send /model.
require("codex").show_status() send /status.
require("codex").show_permissions() send /permissions.
require("codex").compact() send /compact.
require("codex").review(instructions) send /review.
require("codex").show_diff() send /diff.
require("codex").resume(opts) resume (opts.last supports --last).
require("codex").send_buffer(opts) send buffer/file path as @path with a trailing space. Set opts.path to send an explicit file path (takes precedence over opts.bufnr), and set opts.focus = false to keep editor focus.
require("codex").send_selection(opts) send visual/range selection with a trailing newline after the fenced block.
require("codex").mention_file(path, opts) send /mention for a file path (opts.post_execute(ok, err) runs after mention execution completes).
require("codex").mention_directory(path, opts) send /mention for a directory path (opts.post_execute(ok, err) runs after mention execution completes).
require("codex").is_running() check whether active session is alive.
require("codex").get_config() return resolved config snapshot.
require("codex").get_logs() return captured in-memory logs.
require("codex").clear_logs() clear captured in-memory logs.

For command and component interaction details, see docs/command-interactions.md.

Providers

auto (default) prefers snacks when available, falls back to native. See docs/architecture.md for the full provider interface and implementation details.

Development

See docs/contributing.md for setup, testing, formatting, linting, and code style guidelines.

Troubleshooting

See docs/troubleshooting.md for logging-focused debugging steps and issue report guidance.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

codex.nvim

Requirements

Install

Configuration

Commands

Keymaps

Lua API

Providers

Development

Troubleshooting

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

codex.nvim

Requirements

Install

Configuration

Commands

Keymaps

Lua API

Providers

Development

Troubleshooting