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 details may differ from tagged releases. The current latest release tag is v1.0.0-rc1. For version-accurate instructions, read the README for your target tag from Codeberg releases.

Install

{
  url = "https://codeberg.org/yaadata/codex.nvim.git",
  version = "1.0.0-rc1",
  cmd = {
    "Codex",
    "CodexFocus",
    "CodexClose",
    "CodexClearInput",
    "CodexSendSelection",
    "CodexSendFile",
    "CodexMentionFile",
    "CodexMentionDirectory",
    "CodexResume",
  },
  opts = {},
  config = function(_, opts)
    require("codex").setup(opts)
  end,
}

Usage

After installation, open :help codex.nvim inside Neovim for the full user-facing reference, including:

• setup and the full default options table
• command reference and behavior notes
• public Lua API
• keymap examples
• slash-command examples

Common entry points:

• :Codex toggles the Codex terminal
• :CodexSendSelection sends the active visual selection
• :CodexSendFile sends the current buffer as an ACP file reference
• :CodexMentionFile [path] and :CodexMentionDirectory [path] send /mention
• :CodexResume[!] resumes in-process or launches codex resume

If :help codex.nvim is missing after a local/raw install, generate help tags for the plugin's doc/ directory, for example :helptags {path-to-codex.nvim}/doc. Plugin managers usually do this for you; :helptags ALL is the broad fallback.

Developer Docs

The main runtime docs are in doc/codex.nvim.txt. Developer-oriented docs remain in:

• doc/architecture.md
• doc/contributing.md
• doc/troubleshooting.md