1159eaf04f
The TypeScript version of the CLI shows the version when it starts up, which is helpful when users share screenshots (and nice to know, as a user). |
||
|---|---|---|
| .. | ||
| ansi-escape | ||
| apply-patch | ||
| cli | ||
| common | ||
| core | ||
| docs | ||
| exec | ||
| execpolicy | ||
| linux-sandbox | ||
| mcp-client | ||
| mcp-server | ||
| mcp-types | ||
| scripts | ||
| tui | ||
| .gitignore | ||
| Cargo.lock | ||
| Cargo.toml | ||
| config.md | ||
| default.nix | ||
| justfile | ||
| README.md | ||
| rustfmt.toml | ||
Codex CLI (Rust Implementation)
We provide Codex CLI as a standalone, native executable to ensure a zero-dependency install.
Installing Codex
Today, the easiest way to install Codex is via npm, though we plan to publish Codex to other package managers soon.
npm i -g @openai/codex@native
codex
You can also download a platform-specific release directly from our GitHub Releases.
Config
Codex supports a rich set of configuration options. See config.md for details.
Model Context Protocol Support
Codex CLI functions as an MCP client that can connect to MCP servers on startup. See the mcp_servers section in the configuration documentation for details.
It is still experimental, but you can also launch Codex as an MCP server by running codex mcp. Using the @modelcontextprotocol/inspector is
npx @modelcontextprotocol/inspector codex mcp
Code Organization
This folder is the root of a Cargo workspace. It contains quite a bit of experimental code, but here are the key crates:
core/contains the business logic for Codex. Ultimately, we hope this to be a library crate that is generally useful for building other Rust/native applications that use Codex.exec/"headless" CLI for use in automation.tui/CLI that launches a fullscreen TUI built with Ratatui.cli/CLI multitool that provides the aforementioned CLIs via subcommands.