For the complete documentation index, see llms.txt. This page is also available as Markdown.

Codex CLI

Codex CLI provides OpenAI model access for general security analysis and code-oriented workflows.

Requirements

  • codex CLI installed.

  • OPENAI_API_KEY available in the Burp runtime environment.

Setup

  1. Install CLI:

npm install -g @openai/codex
  1. Export API key:

export OPENAI_API_KEY="sk-..."
  1. Verify locally:

codex "hello"
  1. Configure in AI Backend settings tab.

Configuration

Setting
Value

Preferred Backend

Codex CLI

Codex CLI Command

codex chat (default)

Model example:

Notes

Windows

The extension automatically resolves npm-installed CLI shims on Windows. When codex is configured, the resolver:

  1. Checks for a .cmd sibling next to the resolved path (e.g., codex.cmd alongside codex).

  2. Falls back to wrapping the command with cmd /c if no .cmd sibling is found.

This prevents CreateProcess error=193 that occurs when Java tries to execute a shell script shim directly on Windows.

You do not need to manually specify .cmd extensions. The extension handles this automatically for all npm-installed CLI backends.

Windows + WSL bridge

If Burp runs on Windows and Codex runs in WSL, set Codex CLI Command to a .cmd wrapper that forwards args into WSL.

Wrapper example:

Troubleshooting

  • command not found: use full binary path or npm shim path.

  • Windows: npm shim paths are resolved automatically. If auto-resolution fails, use the full .cmd path: C:\\Users\\<you>\\AppData\\Roaming\\npm\\codex.cmd.

  • Auth errors: verify OPENAI_API_KEY in Burp runtime env.

  • Rate limits: check provider quota/tier.

Last updated