<h1 align="center">Open Codex CLI</h1> <p align="center">Lightweight coding agent that runs in your terminal</p>
npm install open-codexLightweight coding agent that runs in your terminal
npm i -g open-codex
> Important Note: This is a fork of the original OpenAI Codex CLI with expanded model support and changed installation instructions. The main differences in this fork are:
>
> - Support for multiple AI providers (OpenAI, Gemini, OpenRouter, Ollama)
> - Uses the Chat Completion API instead of the Responses API which allows us to support any openai compatible provider and model.
> - All other functionality remains similar to the original project
> - You can install this fork globally with npm i -g open-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
- Recipes
- Installation
- Configuration
- FAQ
- Contributing
- Development workflow
- Writing high‑impact code changes
- Opening a pull request
- Review process
- Community values
- Getting help
- Releasing codex
- Security \& Responsible AI
- License
- Zero Data Retention (ZDR) Organization Limitation
---
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)!
Install globally:
``shell`
npm install -g open-codex
Next, set your API key as an environment variable (shown here with OpenAI, but other providers are supported):
`shell`
export OPENAI_API_KEY="your-api-key-here"
> Note: This command sets the key only for your current terminal session. To make it permanent, add the export line to your shell's configuration file (e.g., ~/.zshrc)..env
>
> Tip: You can also place your API key into a file at the root of your project:`
>
> env`
> OPENAI_API_KEY=your-api-key-here
>
>
> The CLI will automatically load variables from (via dotenv/config).
Run interactively:
`shell`
open-codex
Or, run with a prompt as input (and optionally in Full Auto mode):
`shell`
open-codex "explain this codebase to me"
`shell`
open-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.
---
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 API key and it just works!
- Multiple AI providers — use OpenAI, Gemini, OpenRouter, or Ollama!
- 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!
---
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
• All shell/Bash commands |
| Auto Edit | • Read and apply‑patch writes to files | • All shell/Bash commands |
| Full Auto | • Read/write files
• Execute shell commands | – |
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.
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.).curl
- Outbound network is _fully blocked_ by default – even if a child process
tries to 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 therun_in_container.sh
OpenAI API. This gives you deterministic, reproducible runs without needing
root on the host. You can use the script to set up the sandbox.
---
| 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.
---
| Command | Purpose | Example |
| ----------------------------------------- | ----------------------------------- | ------------------------------------ |
| open-codex | Interactive REPL | codex |open-codex "…"
| | Initial prompt for interactive REPL | codex "fix lint errors" |open-codex -q "…"
| | Non‑interactive "quiet mode" | codex -q --json "explain utils.ts" |open-codex completion
| | Print shell completion script | codex completion bash |
Key flags: --model/-m, --approval-mode/-a, and --quiet/-q.
---
Codex merges Markdown instructions in this order:
1. ~/.codex/instructions.md – personal global guidancecodex.md
2. at repo root – shared project notescodex.md
3. in cwd – sub‑package specifics
Disable with --no-project-doc or CODEX_DISABLE_PROJECT_DOC=1.
---
Run Codex head‑less in pipelines. Example GitHub Action step:
`yaml`
- name: Update changelog via Codex
run: |
npm install -g open-codex
export OPENAI_API_KEY="${{ secrets.OPENAI_KEY }}"
open-codex -a auto-edit --quiet "update CHANGELOG for next release"
Set CODEX_QUIET_MODE=1 to silence interactive UI noise.
Setting the environment variable DEBUG=true prints full API request and response details:
`shell`
DEBUG=true open-codex
---
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. |codex "Generate SQL migrations for adding a users table"
| 2 | | Infers your ORM, creates migration files, and runs them in a sandboxed DB. |codex "Write unit tests for utils/date.ts"
| 3 | | Generates tests, executes them, and iterates until they pass. |codex "Bulk‑rename .jpeg → .jpg with git mv"
| 4 | | Safely renames files and updates imports/usages. |codex "Explain what this regex does: ^(?=.*[A-Z]).{8,}$"
| 5 | | Outputs a step‑by‑step human explanation. |codex "Carefully review this repo, and propose 3 high impact well-scoped PRs"
| 6 | | Suggests impactful PRs in the current codebase. |codex "Look for vulnerabilities and create a security review report"
| 7 | | Finds and explains security bugs. |
---
From npm (Recommended)
`bash`
npm install -g open-codexor
yarn global add open-codex
Build from source
`bashClone the repository and navigate to the CLI package
git clone https://github.com/ymichael/open-codex.git
cd open-codex/codex-cli
---
Configuration
Codex looks for config files in
(either YAML or JSON format).`json
// ~/.codex/config.json
{
"model": "o4-mini", // Default model
"provider": "openai", // Default provider
"approvalMode": "suggest", // or auto-edit, full-auto
"fullAutoErrorMode": "ask-user" // or ignore-and-continue
}
`You can also define custom instructions:
md
~/.codex/instructions.md
- Always respond with emojis
- Only use git commands if I explicitly mention you should
`$3
This fork of Codex supports multiple AI providers:
- openai (default)
- gemini
- openrouter
- ollama
- xai
To use a different provider, set the
key in your config file:`json
{
"provider": "gemini"
}
`OR use the
flag. eg. codex --provider geminiHere's a list of all the providers and their default models:
| Provider | Environment Variable Required | Default Agentic Model | Default Full Context Model |
| ---------- | ----------------------------- | ---------------------------- | -------------------------- |
| openai | OPENAI_API_KEY | o4-mini | o3 |
| gemini | GOOGLE_GENERATIVE_AI_API_KEY | gemini-2.5-pro-preview-03-25 | gemini-2.0-flash |
| openrouter | OPENROUTER_API_KEY | openai/o4-mini | openai/o3 |
| ollama | Not required | User must specify | User must specify |
| xai | XAI_API_KEY | grok-3-mini-beta | grok-3-beta |
#### When using an alternative provider, make sure you have the correct environment variables set.
bash
export GOOGLE_GENERATIVE_AI_API_KEY="your-gemini-api-key-here"
`---
FAQ
What's the difference between this and the original OpenAI Codex CLI?
This is a fork of the original OpenAI Codex CLI project with expanded support for multiple AI providers beyond just OpenAI. The installation package is also different (
instead of @openai/codex), but the core functionality remains similar.
How do I stop Codex from touching my repo?
Codex always runs in a sandbox first. If a proposed command or file change looks suspicious you can simply answer n when prompted and nothing happens to your working tree.
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.
Which models are supported?
The default is
o4-mini, but pass --model gpt-4o or set model: gpt-4o in your config file to override.You can also use models from other providers like Gemini and OpenRouter. See the Configuration section for more details.
---
Zero Data Retention (ZDR) Organization Limitation
> Note: Codex CLI does not currently support OpenAI organizations with Zero Data Retention (ZDR) enabled.
If your OpenAI organization has Zero Data Retention enabled, you may 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.
Why?
- Codex CLI relies on the Responses API with
to enable internal reasoning steps.
- As noted in the docs, the Responses API requires a 30-day retention period by default, or when the store parameter is set to true.
- ZDR organizations cannot use store:true, so requests will fail.What can I do?
- If you are part of a ZDR organization, Codex CLI will not work until support is added.
- We are tracking this limitation and will update the documentation if support becomes available.
Funding Opportunity
We’re excited to launch a $1 million initiative supporting open source projects that use Codex CLI and other OpenAI models.
- Grants are awarded in $25,000 API credit increments.
- 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.
$3
- 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 npm run 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:
`bash
npm test && npm run lint && npm run typecheck
`bash
Watch mode (tests rerun on change)
npm run test:watchType‑check without emitting files
npm run typecheckAutomatically fix lint + prettier issues
npm run lint:fix
npm run format:fix
`$3
1. 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.
2. 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.
3. Document behaviour. If your change affects user‑facing behaviour, update the README, inline help (
), or relevant example projects.
4. Keep commits atomic. Each commit should compile and the tests should pass. This makes reviews and potential rollbacks easier.$3
- 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.$3
1. One maintainer will be assigned as a primary reviewer.
2. We may ask for changes – please do not take this personally. We value the work, we just also value consistency and long‑term maintainability.
3. When there is consensus that the PR meets the bar, a maintainer will squash‑and‑merge.
$3
- 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.
$3
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! :rocket:
$3
To publish a new version of the CLI, run the release scripts defined in
codex-cli/package.json:1. Open the
codex-cli directory
2. Make sure you're on a branch like git checkout -b bump-version
3. Bump the version and to current datetime: npm run release:version
4. Commit the version bump (with DCO sign-off):
bash
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\")"
`
5. Copy README, build, and publish to npm:
6. Push to branch: ---
Have you discovered a vulnerability or have concerns about model output? Please e‑mail security@openai.com and we will respond promptly.
---
This repository is licensed under the Apache-2.0 License.
Original project: OpenAI Codex CLI