Developer platform

Embed and automate the Codex coding agent with the CLI, TypeScript SDK, and MCP interfaces.

Table of Contents

Choose an interface
Install the CLI
How the pieces fit
Source of truth

Codex is an open-source coding agent that runs locally. Use the CLI interactively, embed it in a Node.js application with the TypeScript SDK, or expose a running Codex engine through its experimental MCP server.

Choose an interface

Interface	Use it for	Status
CLI	Interactive work, scripts, and CI	Stable
TypeScript SDK	Embedding Codex in Node.js applications	Beta
MCP server	Letting another MCP client control Codex	Experimental
MCP client configuration	Connecting Codex to external tools and services	Stable

Install the CLI

npm install -g @openai/codex
codex

Codex can also be installed with the standalone installer or Homebrew. See the CLI guide for platform-specific options.

How the pieces fit

Your application ── TypeScript SDK ── codex CLI ── local repository
Other MCP client ── stdio MCP ─────── codex mcp-server
Codex CLI ──────── MCP client ──────── configured external servers

The SDK and MCP server operate the local Codex engine; they are not clients for a hosted REST API. A thread holds conversation state, a turn is one submitted user request, and items describe the work produced during that turn.

Source of truth

The implementation and examples live in the openai/codex repository. The TypeScript SDK and MCP server interface document the public surfaces.

更新于 2026年8月31日