codex.nvim
OpenAI Codex plugin for Neovim
Safety scan
A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.
Badge for your README
Markdown
[](/listings/johnseth97--codex-nvim)HTML
<a href="/listings/johnseth97--codex-nvim"><img src="/api/listings/johnseth97--codex-nvim/badge.svg" alt="findsafeskills safety rating" /></a>Install
Install instructions from the README
As written by the repo's author. findsafeskills has not verified these steps.
- Install the `codex` CLI via npm, or mark autoinstall as true in the config function
npm install -g @openai/codex
- Grab an API key from OpenAI and set it in your environment variables: - Note: You can also set it in your `~/.bashrc` or `~/.zshrc` file to persist across sessions, but be careful with security. Especially if you share your config files.
export OPENAI_API_KEY=your_api_key
- Use your plugin manager, e.g. lazy.nvim:
return {
'kkrampis/codex.nvim',
lazy = true,
cmd = { 'Codex', 'CodexToggle' }, -- Optional: Load only on command execution
keys = {
{
'<leader>cc', -- Change this to your preferred keybinding
function() require('codex').toggle() end,
desc = 'Toggle Codex popup or side-panel',
mode = { 'n', 't' }
},
},
opts = {
keymaps = {
toggle = nil, -- Keybind to toggle Codex window (Disabled by default, watch out for conflicts)
quit = '<C-q>', -- Keybind to close the Codex window (default: Ctrl + q)
}, -- Disable internal default keymap (<leader>cc -> :CodexToggle)
border = 'rounded', -- Options: 'single', 'double', or 'rounded'
width = 0.8, -- Width of the floating window (0.0 to 1.0)
height = 0.8, -- Height of the floating window (0.0 to 1.0)
model = nil, -- Optional: pass a string to use a specific model (e.g., 'o3-mini')
autoinstall = true, -- Automatically install the Codex CLI if not found
panel = false, -- Open Codex in a side-panel (vertical split) instead of floating window
use_buffer = false, -- Capture Codex stdout into a normal buffer instead of a terminal buffer
},
}```
### Usage:
- Call `:Codex` (or `:CodexToggle`) to open or close the Codex popup or side-panel.
- Map your own keybindings via the `keymaps.toggle` setting.
- To choose floating popup vs side-panel, set `panel = false` (popup) or `panel = true` (panel) in your setup options.
- To capture Codex output in an editable buffer instead of a terminal, set `use_buffer = true` (or `false` to keep terminal) in your setup options.
- Add the following code to show backgrounded Codex window in lualine:
```lua
require('codex').status() -- drop in to your lualine sectionsWhat was scanned
The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.
README.md · README · 72 lines
View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)
- # Codex Neovim Plugin
- <img width="1480" alt="image" src="https://github.com/user-attachments/assets/eac126c5-e71c-4de9-817a-bf4e8f2f6af9" />
- ## A Neovim plugin integrating the open-sourced Codex CLI (`codex`)
- > Latest version: 
- ### Features:
- - ✅ Toggle Codex window or side-panel with `:CodexToggle`
- - ✅ Optional keymap mapping via `setup` call
- - ✅ Background running when window hidden
- - ✅ Statusline integration via `require('codex').status()`
- ### Installation:
- - Install the `codex` CLI via npm, or mark autoinstall as true in the config function
- ```bash
- npm install -g @openai/codex
- ```
- - Grab an API key from OpenAI and set it in your environment variables:
- - Note: You can also set it in your `~/.bashrc` or `~/.zshrc` file to persist across sessions, but be careful with security. Especially if you share your config files.
- ```bash
- export OPENAI_API_KEY=your_api_key
- ```
- - Use your plugin manager, e.g. lazy.nvim:
- ```lua
- return {
- 'kkrampis/codex.nvim',
- lazy = true,
- cmd = { 'Codex', 'CodexToggle' }, -- Optional: Load only on command execution
- keys = {
- {
- '<leader>cc', -- Change this to your preferred keybinding
- function() require('codex').toggle() end,
- desc = 'Toggle Codex popup or side-panel',
- mode = { 'n', 't' }
- },
- },
- opts = {
- keymaps = {
- toggle = nil, -- Keybind to toggle Codex window (Disabled by default, watch out for conflicts)
- quit = '<C-q>', -- Keybind to close the Codex window (default: Ctrl + q)
- }, -- Disable internal default keymap (<leader>cc -> :CodexToggle)
- border = 'rounded', -- Options: 'single', 'double', or 'rounded'
- width = 0.8, -- Width of the floating window (0.0 to 1.0)
- height = 0.8, -- Height of the floating window (0.0 to 1.0)
- model = nil, -- Optional: pass a string to use a specific model (e.g., 'o3-mini')
- autoinstall = true, -- Automatically install the Codex CLI if not found
- panel = false, -- Open Codex in a side-panel (vertical split) instead of floating window
- use_buffer = false, -- Capture Codex stdout into a normal buffer instead of a terminal buffer
- },
- }```
- ### Usage:
- - Call `:Codex` (or `:CodexToggle`) to open or close the Codex popup or side-panel.
- - Map your own keybindings via the `keymaps.toggle` setting.
- - To choose floating popup vs side-panel, set `panel = false` (popup) or `panel = true` (panel) in your setup options.
- - To capture Codex output in an editable buffer instead of a terminal, set `use_buffer = true` (or `false` to keep terminal) in your setup options.
- - Add the following code to show backgrounded Codex window in lualine:
- ```lua
- require('codex').status() -- drop in to your lualine sections
- ```
- ### Configuration:
- - All plugin configurations can be seen in the `opts` table of the plugin setup, as shown in the installation section.
- - **For deeper customization, please refer to the [Codex CLI documentation](https://github.com/openai/codex?tab=readme-ov-file#full-configuration-example) full configuration example. These features change quickly as Codex CLI is in active beta development.*
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.