OpenAI Codex CLI

Project Introduction

Codex CLI is a coding agent from OpenAI that runs locally on your computer.

Official Homepage: https://chatgpt.com/codex
Project Homepage: https://github.com/openai/codex

Demo

Features

Feature Category	Feature
Terminal-based Coding Assistant	Codex CLI is a terminal-based interactive coding assistant for editing code, generating patches, and running commands in the command line.
Tool-driven Architecture	Provides tools such as `apply_patch`, `shell`, `update_plan`, and `multi_tool_use` for controlled modifications to repository files and operations.
Atomic Patch Editing	Uses a dedicated patch format to atomically add/update/delete files via `apply_patch`, facilitating auditing and rollback.
Sandboxing and Approval	Supports sandboxing policies (e.g., `workspace-write`, `read-only`) and approval modes (`on-request`, `on-failure`, `never`) to control write and network access permissions.
Plan Tracking	`update_plan` is used to list steps and track status, requiring only one `in_progress` step at all times to maintain clear progress.
Interaction Protocol	Sends brief introductory explanations before important operations, maintaining a friendly, concise tone and providing progress updates.
Security Constraints	Adheres to strict rules (no arbitrary changes to unrelated files, no adding copyright headers, no executing destructive commands), requiring user approval for sensitive operations.
Testing and Formatting	Recommends running relevant tests and formatting tools after modifications, but is not responsible for fixing issues unrelated to the current task.
Output and Style	Final output follows CLI rendering specifications (e.g., `**` for headings, backticks for paths/commands), maintaining a scannable, concise structure.
Parallel Execution	Supports running multiple tools in parallel via `multi_tool_use.parallel` to improve efficiency.

AI Model Configuration Method

Windows Graphical Guide

1. Open Terminal

windows_open_terminal

2. Install WSL

For optimal performance on Windows, install and use Windows Subsystem for Linux (WSL2).

Install WSL2, Restart Windows Computer

wsl --install

Restart your Windows computer after installation.

Windows Notes

It is recommended to use PowerShell instead of CMD
If you encounter permission issues, try running as administrator
Some antivirus software may falsely flag it; you need to add it to the whitelist

Download Node Version Manager (NVM)

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash

NVM Installs Node.js 22

Open a new PowerShell window in the tab bar, then open WSL:

wsl

Install Node.js (version numbers are time-sensitive; please install the corresponding version according to OpenAI's official website requirements):

nvm install 22

3. Install Codex CLI

Install Codex CLI

npm i -g @openai/codex

This command downloads and installs the latest version of Codex CLI from the official npm repository.

4. Modify Configuration File

One-click Modification of Codex CLI Configuration File

iex (irm 'https://raw.githubusercontent.com/QuantumNous/new-api-docs/refs/heads/main/helper/codex-cli-setup.ps1')

windows-configure

5. Start Using Codex CLI

Now you can start using Codex CLI!

Launch Codex CLI

Launch WSL2:

wsl

Launch Codex CLI directly:

codex

Use in a specific project:

cd mnt/c/path/to/your/project
codex

Press Enter to launch Codex CLI.

Set Codex CLI permissions: 1. Allow Codex to modify files directly; 2. Codex requires manual authorization to modify files

Select Model

/model

Note: After modifying the API address, all models (including officially preset models) will call the custom access point and will not use the official account quota.

macOS Graphical Guide

1. Install Homebrew (Skip if already installed)

Homebrew is the missing package manager for macOS.

Official Website: https://brew.sh

Install Homebrew

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

2. Install Node.js Environment

Node.js Environment Installation Steps

Update Homebrew:

brew update

Install Node.js:

brew install node

macOS Notes

If you encounter permission issues, you might need to use sudo
The first run might require permission in System Preferences
It is recommended to use Terminal or iTerm2

Verify Installation Success

After installation, open the terminal and enter the following commands:

node --version
npm --version

If version numbers are displayed, the installation was successful.

3. Install Codex CLI

Install Codex CLI

Open the terminal and run the following commands:

# Install Codex CLI globally
npm install -g @openai/codex

If you encounter permission issues, you can use sudo:

sudo npm install -g @openai/codex

Verify Codex CLI Installation

After installation, enter the following command to check if the installation was successful:

codex --version

If a version number is displayed, congratulations! Codex CLI has been successfully installed.

4. Modify Configuration File

One-click Modification of Codex CLI Configuration File

curl -fsSL https://raw.githubusercontent.com/QuantumNous/new-api-docs/refs/heads/main/helper/codex-cli-setup.sh | bash

macos-configure

5. Start Using Codex CLI

Now you can start using Codex CLI!

Launch Codex CLI

Launch Codex CLI directly:

codex

Use in a specific project:

cd /path/to/your/project
codex

Press Enter to launch Codex CLI.

Set Codex CLI permissions: 1. Allow Codex to modify files directly; 2. Codex requires manual authorization to modify files

Note: After modifying the API address, all models (including officially preset models) will call the custom access point and will not use the official account quota.

6. macOS Common Issues Troubleshooting

Permission Error During Installation

Try the following solutions:

Install with sudo: sudo npm install -g @openai/codex
Or configure npm to use the user directory: npm config set prefix ~/.npm-global

macOS Security Settings Prevent Running

If the system prevents Codex CLI from running:

Open "System Preferences" → "Security & Privacy"
Click "Open Anyway" or "Allow"
Or run in Terminal: sudo spctl --master-disable

Linux Graphical Guide

1. Install Node.js Environment

Codex CLI requires a Node.js environment to run.

Node.js Environment Installation Steps

Add NodeSource repository:

sudo curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -

Install Node.js:

sudo apt-get install -y nodejs

Linux Notes

Some distributions may require additional dependencies
If you encounter permission issues, use sudo
Ensure your user has write permissions in npm's global directory

Verify Installation Success

After installation, open the terminal and enter the following commands:

node --version
npm --version

If version numbers are displayed, the installation was successful.

2. Install Codex CLI

Install Codex CLI

Open the terminal and run the following commands:

# Install Codex CLI globally
npm install -g @openai/codex

If you encounter permission issues, you can use sudo:

sudo npm install -g @openai/codex

Verify Codex CLI Installation

After installation, enter the following command to check if the installation was successful:

codex --version

If a version number is displayed, congratulations! Codex CLI has been successfully installed.

3. Modify Configuration File

One-click Modification of Codex CLI Configuration File

curl -fsSL https://raw.githubusercontent.com/QuantumNous/new-api-docs/refs/heads/main/helper/codex-cli-setup.sh | bash

macos-configure

4. Start Using Codex CLI

Now you can start using Codex CLI!

Launch Codex CLI

Launch Codex CLI directly:

codex

Use in a specific project:

# Navigate to your project directory
cd /path/to/your/project

# Launch Codex CLI
codex

Press Enter to launch Codex CLI.

Set Codex CLI permissions: 1. Allow Codex to modify files directly; 2. Codex requires manual authorization to modify files

Note: After modifying the API address, all models (including officially preset models) will call the custom access point and will not use the official account quota.

5. Linux Common Issues Troubleshooting

Permission Error During Installation

Try the following solutions:

Install with sudo: sudo npm install -g @openai/codex
Or configure npm to use the user directory: npm config set prefix ~/.npm-global
Then add to PATH: export PATH=~/.npm-global/bin:$PATH

Missing Dependency Libraries

Some Linux distributions require additional dependencies:

# Ubuntu/Debian
sudo apt install build-essential

# CentOS/RHEL
sudo dnf groupinstall "Development Tools"

OpenAI Codex CLI

On this page