OpenAI Codex CLI

Lightweight coding agent that runs in your terminal

npm i -g @openai/codex

Table of Contents

Experimental Technology Disclaimer
Quickstart
Why Codex?
Security Model & Permissions
- Platform sandboxing details
System Requirements
CLI Reference
Memory & Project Docs
Non-interactive / CI mode
Tracing / Verbose Logging
Recipes
Installation
Configuration Guide
FAQ
Zero Data Retention (ZDR) Usage
Codex Open Source Fund
Contributing
Security & Responsible AI
License

Experimental Technology Disclaimer

Codex CLI is an experimental project under active development. It is not yet stable, may contain bugs, incomplete features, or undergo breaking changes. We're building it in the open with the community and welcome:

Bug reports
Feature requests
Pull requests
Good vibes

Help us improve by filing issues or submitting PRs (see the section below for how to contribute)!

Quickstart

Install globally:

npm install -g @openai/codex

Next, set your OpenAI API key as an environment variable:

export OPENAI_API_KEY="your-api-key-here"

Note: This command sets the key only for your current terminal session. You can add the export line to your shell's configuration file (e.g., ~/.zshrc) but we recommend setting for the session. Tip: You can also place your API key into a .env file at the root of your project:
OPENAI_API_KEY=your-api-key-here
The CLI will automatically load variables from .env (via dotenv/config).

Use --provider to use other models

Codex also allows you to use other providers that support the OpenAI Chat Completions API. You can set the provider in the config file or use the --provider flag. The possible options for --provider are:

openai (default)

openrouter

gemini

ollama

mistral

deepseek

xai

groq

any other provider that is compatible with the OpenAI API

If you use a provider other than OpenAI, you will need to set the API key for the provider in the config file or in the environment variable as:
export <provider>_API_KEY="your-api-key-here"
If you use a provider not listed above, you must also set the base URL for the provider:
export <provider>_BASE_URL="https://your-provider-api-base-url"

Run interactively:

codex

Or, run with a prompt as input (and optionally in Full Auto mode):

codex "explain this codebase to me"

codex --approval-mode full-auto "create the fanciest todo-list app"

That's it - Codex will scaffold a file, run it inside a sandbox, install any missing dependencies, and show you the live result. Approve the changes and they'll be committed to your working directory.

Why Codex?

Codex CLI is built for developers who already live in the terminal and want ChatGPT-level reasoning plus the power to actually run code, manipulate files, and iterate - all under version control. In short, it's chat-driven development that understands and executes your repo.

Zero setup - bring your OpenAI API key and it just works!
Full auto-approval, while safe + secure by running network-disabled and directory-sandboxed
Multimodal - pass in screenshots or diagrams to implement features ✨

And it's fully open-source so you can see and contribute to how it develops!

Security Model & Permissions

Codex lets you decide how much autonomy the agent receives and auto-approval policy via the --approval-mode flag (or the interactive onboarding prompt):

Mode	What the agent may do without asking	Still requires approval
Suggest (default)	Read any file in the repo	All file writes/patches Any arbitrary shell commands (aside from reading files)
Auto Edit	Read and apply-patch writes to files	All shell commands
Full Auto	Read/write files Execute shell commands (network disabled, writes limited to your workdir)	-

In Full Auto every command is run network-disabled and confined to the current working directory (plus temporary files) for defense-in-depth. Codex will also show a warning/confirmation if you start in auto-edit or full-auto while the directory is not tracked by Git, so you always have a safety net.

Coming soon: you'll be able to whitelist specific commands to auto-execute with the network enabled, once we're confident in additional safeguards.

Platform sandboxing details

The hardening mechanism Codex uses depends on your OS:

macOS 12+ - commands are wrapped with Apple Seatbelt (sandbox-exec).
- Everything is placed in a read-only jail except for a small set of writable roots ($PWD, $TMPDIR, ~/.codex, etc.).
- Outbound network is fully blocked by default - even if a child process tries to curl somewhere it will fail.
Linux - there is no sandboxing by default. We recommend using Docker for sandboxing, where Codex launches itself inside a minimal container image and mounts your repo read/write at the same path. A custom iptables/ipset firewall script denies all egress except the OpenAI API. This gives you deterministic, reproducible runs without needing root on the host. You can use the run_in_container.sh script to set up the sandbox.

System Requirements

Requirement	Details
Operating systems	macOS 12+, Ubuntu 20.04+/Debian 10+, or Windows 11 via WSL2
Node.js	22 or newer (LTS recommended)
Git (optional, recommended)	2.23+ for built-in PR helpers
RAM	4-GB minimum (8-GB recommended)

Never run sudo npm install -g; fix npm permissions instead.

CLI Reference

Command	Purpose	Example
`codex`	Interactive REPL	`codex`
`codex "..."`	Initial prompt for interactive REPL	`codex "fix lint errors"`
`codex -q "..."`	Non-interactive "quiet mode"	`codex -q --json "explain utils.ts"`
`codex completion <bash\|zsh\|fish>`	Print shell completion script	`codex completion bash`

Key flags: --model/-m, --approval-mode/-a, --quiet/-q, and --notify.

Memory & Project Docs

Codex merges Markdown instructions in this order:

~/.codex/instructions.md - personal global guidance
codex.md at repo root - shared project notes
codex.md in cwd - sub-package specifics

Disable with --no-project-doc or CODEX_DISABLE_PROJECT_DOC=1.

Non-interactive / CI mode

Run Codex head-less in pipelines. Example GitHub Action step:

- name: Update changelog via Codex
  run: |
    npm install -g @openai/codex
    export OPENAI_API_KEY="${{ secrets.OPENAI_KEY }}"
    codex -a auto-edit --quiet "update CHANGELOG for next release"

Set CODEX_QUIET_MODE=1 to silence interactive UI noise.

Tracing / Verbose Logging

Setting the environment variable DEBUG=true prints full API request and response details:

DEBUG=true codex

Recipes

Below are a few bite-size examples you can copy-paste. Replace the text in quotes with your own task. See the prompting guide for more tips and usage patterns.

✨	What you type	What happens
1	`codex "Refactor the Dashboard component to React Hooks"`	Codex rewrites the class component, runs `npm test`, and shows the diff.
2	`codex "Generate SQL migrations for adding a users table"`	Infers your ORM, creates migration files, and runs them in a sandboxed DB.
3	`codex "Write unit tests for utils/date.ts"`	Generates tests, executes them, and iterates until they pass.
4	`codex "Bulk-rename .jpeg -> .jpg with git mv"`	Safely renames files and updates imports/usages.
5	`codex "Explain what this regex does: ^(?=.*[A-Z]).{8,}$"`	Outputs a step-by-step human explanation.
6	`codex "Carefully review this repo, and propose 3 high impact well-scoped PRs"`	Suggests impactful PRs in the current codebase.
7	`codex "Look for vulnerabilities and create a security review report"`	Finds and explains security bugs.

Installation

From npm (Recommended)

npm install -g @openai/codex
# or
yarn global add @openai/codex
# or
bun install -g @openai/codex
# or
pnpm add -g @openai/codex

Build from source

# Clone the repository and navigate to the CLI package
git clone https://github.com/openai/codex.git
cd codex/codex-cli

# Enable corepack
corepack enable

# Install dependencies and build
pnpm install
pnpm build

# Get the usage and the options
node ./dist/cli.js --help

# Run the locally-built CLI directly
node ./dist/cli.js

# Or link the command globally for convenience
pnpm link

Configuration Guide

Codex configuration files can be placed in the ~/.codex/ directory, supporting both YAML and JSON formats.

Basic Configuration Parameters

Parameter	Type	Default	Description	Available Options
`model`	string	`o4-mini`	AI model to use	Any model name supporting OpenAI API
`approvalMode`	string	`suggest`	AI assistant's permission mode	`suggest` (suggestions only) `auto-edit` (automatic edits) `full-auto` (fully automatic)
`fullAutoErrorMode`	string	`ask-user`	Error handling in full-auto mode	`ask-user` (prompt for user input) `ignore-and-continue` (ignore and proceed)
`notify`	boolean	`true`	Enable desktop notifications	`true`/`false`

Custom AI Provider Configuration

In the providers object, you can configure multiple AI service providers. Each provider requires the following parameters:

Parameter	Type	Description	Example
`name`	string	Display name of the provider	`"OpenAI"`
`baseURL`	string	API service URL	`"https://api.openai.com/v1"`
`envKey`	string	Environment variable name (for API key)	`"OPENAI_API_KEY"`

History Configuration

In the history object, you can configure conversation history settings:

Parameter	Type	Description	Example Value
`maxSize`	number	Maximum number of history entries to save	`1000`
`saveHistory`	boolean	Whether to save history	`true`
`sensitivePatterns`	array	Patterns of sensitive information to filter in history	`[]`

Configuration Examples

YAML format (save as ~/.codex/config.yaml):

model: o4-mini
approvalMode: suggest
fullAutoErrorMode: ask-user
notify: true

JSON format (save as ~/.codex/config.json):

{
  "model": "o4-mini",
  "approvalMode": "suggest",
  "fullAutoErrorMode": "ask-user",
  "notify": true
}

Full Configuration Example

Below is a comprehensive example of config.json with multiple custom providers:

{
  "model": "o4-mini",
  "provider": "openai",
  "providers": {
    "openai": {
      "name": "OpenAI",
      "baseURL": "https://api.openai.com/v1",
      "envKey": "OPENAI_API_KEY"
    },
    "openrouter": {
      "name": "OpenRouter",
      "baseURL": "https://openrouter.ai/api/v1",
      "envKey": "OPENROUTER_API_KEY"
    },
    "gemini": {
      "name": "Gemini",
      "baseURL": "https://generativelanguage.googleapis.com/v1beta/openai",
      "envKey": "GEMINI_API_KEY"
    },
    "ollama": {
      "name": "Ollama",
      "baseURL": "http://localhost:11434/v1",
      "envKey": "OLLAMA_API_KEY"
    },
    "mistral": {
      "name": "Mistral",
      "baseURL": "https://api.mistral.ai/v1",
      "envKey": "MISTRAL_API_KEY"
    },
    "deepseek": {
      "name": "DeepSeek",
      "baseURL": "https://api.deepseek.com",
      "envKey": "DEEPSEEK_API_KEY"
    },
    "xai": {
      "name": "xAI",
      "baseURL": "https://api.x.ai/v1",
      "envKey": "XAI_API_KEY"
    },
    "groq": {
      "name": "Groq",
      "baseURL": "https://api.groq.com/openai/v1",
      "envKey": "GROQ_API_KEY"
    }
  },
  "history": {
    "maxSize": 1000,
    "saveHistory": true,
    "sensitivePatterns": []
  }
}

Custom Instructions

You can create a ~/.codex/instructions.md file to define custom instructions:

- Always respond with emojis
- Only use git commands when explicitly requested

Environment Variables Setup

For each AI provider, you need to set the corresponding API key in your environment variables. For example:

# OpenAI
export OPENAI_API_KEY="your-api-key-here"

# OpenRouter
export OPENROUTER_API_KEY="your-openrouter-key-here"

# Similarly for other providers

FAQ

OpenAI released a model called Codex in 2021 - is this related?

In 2021, OpenAI released Codex, an AI system designed to generate code from natural language prompts. That original Codex model was deprecated as of March 2023 and is separate from the CLI tool.

Which models are supported?

Any model available with Responses API. The default is o4-mini, but pass --model gpt-4.1 or set model: gpt-4.1 in your config file to override.

Why does o3 or o4-mini not work for me?

It's possible that your API account needs to be verified in order to start streaming responses and seeing chain of thought summaries from the API. If you're still running into issues, please let us know!

How do I stop Codex from editing my files?

Codex runs model-generated commands in a sandbox. If a proposed command or file change doesn't look right, you can simply type n to deny the command or give the model feedback.

Does it work on Windows?

Not directly. It requires Windows Subsystem for Linux (WSL2) - Codex has been tested on macOS and Linux with Node 22.

Zero Data Retention (ZDR) Usage

Codex CLI does support OpenAI organizations with Zero Data Retention (ZDR) enabled. If your OpenAI organization has Zero Data Retention enabled and you still encounter errors such as:

OpenAI rejected the request. Error details: Status: 400, Code: unsupported_parameter, Type: invalid_request_error, Message: 400 Previous response cannot be used for this organization due to Zero Data Retention.

You may need to upgrade to a more recent version with: npm i -g @openai/codex@latest

Codex Open Source Fund

We're excited to launch a $1 million initiative supporting open source projects that use Codex CLI and other OpenAI models.

Grants are awarded up to $25,000 API credits.
Applications are reviewed on a rolling basis.

Interested? Apply here.

Contributing

This project is under active development and the code will likely change pretty significantly. We'll update this message once that's complete!

More broadly we welcome contributions - whether you are opening your very first pull request or you're a seasoned maintainer. At the same time we care about reliability and long-term maintainability, so the bar for merging code is intentionally high. The guidelines below spell out what "high-quality" means in practice and should make the whole process transparent and friendly.

Development workflow

Create a topic branch from main - e.g. feat/interactive-prompt.
Keep your changes focused. Multiple unrelated fixes should be opened as separate PRs.
Use pnpm test:watch during development for super-fast feedback.
We use Vitest for unit tests, ESLint + Prettier for style, and TypeScript for type-checking.
Before pushing, run the full test/type/lint suite:

Git Hooks with Husky

This project uses Husky to enforce code quality checks:

Pre-commit hook: Automatically runs lint-staged to format and lint files before committing
Pre-push hook: Runs tests and type checking before pushing to the remote

These hooks help maintain code quality and prevent pushing code with failing tests. For more details, see HUSKY.md.

pnpm test && pnpm run lint && pnpm run typecheck

If you have not yet signed the Contributor License Agreement (CLA), add a PR comment containing the exact text
```
I have read the CLA Document and I hereby sign the CLA
```
The CLA-Assistant bot will turn the PR status green once all authors have signed.

# Watch mode (tests rerun on change)
pnpm test:watch

# Type-check without emitting files
pnpm typecheck

# Automatically fix lint + prettier issues
pnpm lint:fix
pnpm format:fix

Debugging

To debug the CLI with a visual debugger, do the following in the codex-cli folder:

Run pnpm run build to build the CLI, which will generate cli.js.map alongside cli.js in the dist folder.
Run the CLI with node --inspect-brk ./dist/cli.js The program then waits until a debugger is attached before proceeding. Options:
- In VS Code, choose Debug: Attach to Node Process from the command palette and choose the option in the dropdown with debug port 9229 (likely the first option)
- Go to chrome://inspect in Chrome and find localhost:9229 and click trace

Writing high-impact code changes

Start with an issue. Open a new one or comment on an existing discussion so we can agree on the solution before code is written.
Add or update tests. Every new feature or bug-fix should come with test coverage that fails before your change and passes afterwards. 100% coverage is not required, but aim for meaningful assertions.
Document behaviour. If your change affects user-facing behaviour, update the README, inline help (codex --help), or relevant example projects.
Keep commits atomic. Each commit should compile and the tests should pass. This makes reviews and potential rollbacks easier.

Opening a pull request

Fill in the PR template (or include similar information) - What? Why? How?
Run all checks locally (npm test && npm run lint && npm run typecheck). CI failures that could have been caught locally slow down the process.
Make sure your branch is up-to-date with main and that you have resolved merge conflicts.
Mark the PR as Ready for review only when you believe it is in a merge-able state.

Review process

One maintainer will be assigned as a primary reviewer.
We may ask for changes - please do not take this personally. We value the work, we just also value consistency and long-term maintainability.
When there is consensus that the PR meets the bar, a maintainer will squash-and-merge.

Community values

Be kind and inclusive. Treat others with respect; we follow the Contributor Covenant.
Assume good intent. Written communication is hard - err on the side of generosity.
Teach & learn. If you spot something confusing, open an issue or PR with improvements.

Getting help

If you run into problems setting up the project, would like feedback on an idea, or just want to say hi - please open a Discussion or jump into the relevant issue. We are happy to help.

Together we can make Codex CLI an incredible tool. Happy hacking! 🚀

Contributor License Agreement (CLA)

All contributors must accept the CLA. The process is lightweight:

Open your pull request.
Paste the following comment (or reply recheck if you've signed before):
```
I have read the CLA Document and I hereby sign the CLA
```
The CLA-Assistant bot records your signature in the repo and marks the status check as passed.

No special Git commands, email attachments, or commit footers required.

Quick fixes

Scenario	Command
Amend last commit	`git commit --amend -s --no-edit && git push -f`

The DCO check blocks merges until every commit in the PR carries the footer (with squash this is just the one).

Releasing `codex`

To publish a new version of the CLI, run the release scripts defined in codex-cli/package.json:

Open the codex-cli directory
Make sure you're on a branch like git checkout -b bump-version
Bump the version and CLI_VERSION to current datetime: pnpm release:version

Commit the version bump (with DCO sign-off):

git add codex-cli/src/utils/session.ts codex-cli/package.json
git commit -s -m "chore(release): codex-cli v$(node -p \"require('./codex-cli/package.json').version\")"

Copy README, build, and publish to npm: pnpm release
Push to branch: git push origin HEAD

Alternative Build Options

Nix Flake Development

Prerequisite: Nix >= 2.4 with flakes enabled (experimental-features = nix-command flakes in ~/.config/nix/nix.conf).

Enter a Nix development shell:

nix develop

This shell includes Node.js, installs dependencies, builds the CLI, and provides a codex command alias.

Build and run the CLI directly:

nix build
./result/bin/codex --help

Run the CLI via the flake app:

nix run .#codex

Security & Responsible AI

Have you discovered a vulnerability or have concerns about model output? Please e-mail security@openai.com and we will respond promptly.

License

This repository is licensed under the Apache-2.0 License.

License

hkirat/codex

ErrorLooks like something went wrong!

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages