# Codex

> The purpose of Codex CLI is to provide developers with a local, command-line interface to interact with OpenAI’s coding agent, Codex. It enables users to generate code, execute commands, manage projects, and explore codebases using natural language prompts. The CLI serves as a powerful tool for enhancing productivity, especially for those who prefer or require a local environment over cloud-based solutions. It supports integration with IDEs, offers features like code execution, file search, markdown rendering, and interactive feedback loops — all designed to facilitate seamless coding workflows.

**Remember:**
- Codex CLI: The command-line interface for interacting with the OpenAI coding agent
- TUI2: Terminal User Interface 2, responsible for rendering and managing the interactive terminal experience
- Streaming: Real-time interaction and output handling for long-running or complex tasks
- Markdown Rendering: Support for rendering formatted text (including code blocks) in the terminal
- History Cell: Tracks and displays past commands and their outputs for easy reference
- Model Migration: Facilitates switching between different AI models (e.g., GPT-5, Codex, Mini)

## Docs
- [Getting Started](https://github.com/openai/codex/blob/main/docs/getting-started.md): install & quickstart.
- [Install](https://github.com/openai/codex/blob/main/docs/install.md): install & quickstart.
- [Install Native Deps](https://github.com/openai/codex/blob/main/codex-cli/scripts/install_native_deps.py): install & quickstart.
- [License](https://github.com/openai/codex/blob/main/codex-rs/core/src/skills/assets/samples/skill-installer/LICENSE.txt): install & quickstart.
- [Skill](https://github.com/openai/codex/blob/main/codex-rs/core/src/skills/assets/samples/skill-installer/SKILL.md): install & quickstart.
- [Github Utils](https://github.com/openai/codex/blob/main/codex-rs/core/src/skills/assets/samples/skill-installer/scripts/github_utils.py): install & quickstart.
- [Install Skill From Github](https://github.com/openai/codex/blob/main/codex-rs/core/src/skills/assets/samples/skill-installer/scripts/install-skill-from-github.py): install & quickstart.
- [List Curated Skills](https://github.com/openai/codex/blob/main/codex-rs/core/src/skills/assets/samples/skill-installer/scripts/list-curated-skills.py): install & quickstart.
- [Example Config](https://github.com/openai/codex/blob/main/docs/example-config.md): worked example.
- [Agents Md](https://github.com/openai/codex/blob/main/docs/agents_md.md): docs page.

## API
- [README](https://github.com/openai/codex/blob/main/codex-rs/codex-api/README.md): install & quickstart.
- [README](https://github.com/openai/codex/blob/main/codex-rs/responses-api-proxy/README.md): install & quickstart.
- [README](https://github.com/openai/codex/blob/main/sdk/typescript/README.md): install & quickstart.
- [README](https://github.com/openai/codex/blob/main/codex-rs/responses-api-proxy/npm/README.md): install & quickstart.
- [Eslint.Config](https://github.com/openai/codex/blob/main/sdk/typescript/eslint.config.js): docs page.
- [Tsup.Config](https://github.com/openai/codex/blob/main/sdk/typescript/tsup.config.ts): docs page.
- [Abort.Test](https://github.com/openai/codex/blob/main/sdk/typescript/tests/abort.test.ts): docs page.
- [Basic Streaming](https://github.com/openai/codex/blob/main/sdk/typescript/samples/basic_streaming.ts): docs page.
- [Codex](https://github.com/openai/codex/blob/main/sdk/typescript/src/codex.ts): docs page.
- [Codexexecspy](https://github.com/openai/codex/blob/main/sdk/typescript/tests/codexExecSpy.ts): docs page.

## Optional
- [Changelog](https://github.com/openai/codex/blob/main/CHANGELOG.md): version history.
- [Osrelease](https://github.com/openai/codex/blob/main/shell-tool-mcp/src/osRelease.ts): version history.
- [Osrelease.Test](https://github.com/openai/codex/blob/main/shell-tool-mcp/tests/osRelease.test.ts): version history.
- [License](https://github.com/openai/codex/blob/main/codex-rs/core/src/skills/assets/samples/skill-creator/license.txt): usage terms.
- [README](https://github.com/openai/codex/blob/main/.devcontainer/README.md): install & quickstart.
- [Agents](https://github.com/openai/codex/blob/main/AGENTS.md): docs page.
- [Pnpm](https://github.com/openai/codex/blob/main/PNPM.md): docs page.
- [README](https://github.com/openai/codex/blob/main/README.md): docs page.

## .Github
- [Pull Request Template](https://github.com/openai/codex/blob/main/.github/pull_request_template.md): docs page.
- [Issue Deduplicator](https://github.com/openai/codex/blob/main/.github/prompts/issue-deduplicator.txt): docs page.
- [Issue Labeler](https://github.com/openai/codex/blob/main/.github/prompts/issue-labeler.txt): docs page.
- [Codex Attempt](https://github.com/openai/codex/blob/main/.github/codex/labels/codex-attempt.md): docs page.
- [Codex Review](https://github.com/openai/codex/blob/main/.github/codex/labels/codex-review.md): docs page.
- [Codex Rust Review](https://github.com/openai/codex/blob/main/.github/codex/labels/codex-rust-review.md): docs page.
- [Codex Triage](https://github.com/openai/codex/blob/main/.github/codex/labels/codex-triage.md): docs page.

## Codex Cli
- [README](https://github.com/openai/codex/blob/main/codex-cli/README.md): install & quickstart.
- [README](https://github.com/openai/codex/blob/main/codex-cli/scripts/README.md): install & quickstart.
- [Build Npm Package](https://github.com/openai/codex/blob/main/codex-cli/scripts/build_npm_package.py): docs page.
- [Codex](https://github.com/openai/codex/blob/main/codex-cli/bin/codex.js): docs page.

## Codex Rs
- [README](https://github.com/openai/codex/blob/main/codex-rs/README.md): install & quickstart.
- [README](https://github.com/openai/codex/blob/main/codex-rs/ansi-escape/README.md): install & quickstart.
- [README](https://github.com/openai/codex/blob/main/codex-rs/app-server-test-client/README.md): install & quickstart.
- [README](https://github.com/openai/codex/blob/main/codex-rs/app-server/README.md): install & quickstart.
- [README](https://github.com/openai/codex/blob/main/codex-rs/chatgpt/README.md): install & quickstart.
- [README](https://github.com/openai/codex/blob/main/codex-rs/codex-client/README.md): install & quickstart.
- [README](https://github.com/openai/codex/blob/main/codex-rs/common/README.md): install & quickstart.
- [README](https://github.com/openai/codex/blob/main/codex-rs/core/README.md): install & quickstart.
- [README](https://github.com/openai/codex/blob/main/codex-rs/debug-client/README.md): install & quickstart.
- [README](https://github.com/openai/codex/blob/main/codex-rs/exec-server/README.md): install & quickstart.

## Scripts
- [Readme Toc](https://github.com/openai/codex/blob/main/scripts/readme_toc.py): install & quickstart.
- [Asciicheck](https://github.com/openai/codex/blob/main/scripts/asciicheck.py): docs page.
- [Stage Npm Packages](https://github.com/openai/codex/blob/main/scripts/stage_npm_packages.py): docs page.

## Shell Tool Mcp
- [README](https://github.com/openai/codex/blob/main/shell-tool-mcp/README.md): install & quickstart.
- [Tsup.Config](https://github.com/openai/codex/blob/main/shell-tool-mcp/tsup.config.ts): docs page.
- [Bashselection](https://github.com/openai/codex/blob/main/shell-tool-mcp/src/bashSelection.ts): docs page.
- [Bashselection.Test](https://github.com/openai/codex/blob/main/shell-tool-mcp/tests/bashSelection.test.ts): docs page.
- [Constants](https://github.com/openai/codex/blob/main/shell-tool-mcp/src/constants.ts): docs page.
- [Index](https://github.com/openai/codex/blob/main/shell-tool-mcp/src/index.ts): docs page.
- [Platform](https://github.com/openai/codex/blob/main/shell-tool-mcp/src/platform.ts): docs page.
- [Types](https://github.com/openai/codex/blob/main/shell-tool-mcp/src/types.ts): docs page.
