codex README

The project's README from github.com/openai/codex. As one markdown file: README.md.

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

Codex CLI splash


If you want Codex in your code editor (VS Code, Cursor, Windsurf), install in your IDE.
If you want the desktop app experience, run codex app or visit the Codex App page.
If you are looking for the cloud-based agent from OpenAI, Codex Web, go to chatgpt.com/codex.

Quickstart

Installing and running Codex CLI

Run the following on Mac or Linux to install Codex CLI:

curl -fsSL https://chatgpt.com/codex/install.sh | sh

Run the following on Windows to install Codex CLI:

powershell -ExecutionPolicy ByPass -c "irm https://chatgpt.com/codex/install.ps1 | iex"

The standalone installers download from https://releases.openai.com/codex by default and fall back to GitHub Releases if a metadata or asset download is unavailable. To force GitHub Releases, set CODEX_INSTALLER_USE_RELEASES_OPENAI_COM to false (0 and no are also accepted):

curl -fsSL https://chatgpt.com/codex/install.sh | CODEX_INSTALLER_USE_RELEASES_OPENAI_COM=false sh

$env:CODEX_INSTALLER_USE_RELEASES_OPENAI_COM='false'; irm https://chatgpt.com/codex/install.ps1 | iex

Codex CLI can also be installed via the following package managers:

# Install using npm
npm install -g @openai/codex

# Install using Homebrew
brew install --cask codex

Then simply run codex to get started.

You can also go to the latest GitHub Release and download the appropriate binary for your platform.

Each GitHub Release contains many executables, but in practice, you likely want one of these:

  • macOS
    • Apple Silicon/arm64: codex-aarch64-apple-darwin.tar.gz
    • x86_64 (older Mac hardware): codex-x86_64-apple-darwin.tar.gz
  • Linux
    • x86_64: codex-x86_64-unknown-linux-musl.tar.gz
    • arm64: codex-aarch64-unknown-linux-musl.tar.gz

Each archive contains a single entry with the platform baked into the name (e.g., codex-x86_64-unknown-linux-musl), so you likely want to rename it to codex after extracting it.

Using Codex with your ChatGPT plan

Run codex and select Sign in with ChatGPT. We recommend signing into your ChatGPT account to use Codex as part of your Plus, Pro, Business, Edu, or Enterprise plan. Learn more about what's included in your ChatGPT plan.

You can also use Codex with an API key, but this requires additional setup.

Docs

This repository is licensed under the Apache-2.0 License.

codex (openai/codex)

Searching Database…

129.7K ·GitHub
Codex
Что это такое?Codex — это легковесный агент для написания кода от OpenAI, который работает локально в вашем терминале и помогает писать код и работать с ним на естественном языке.
Это только CLI или есть также расширение для редактора или десктопное приложение?Основа — это CLI для терминала, но Codex также доступен как расширение для VS Code, Cursor и Windsurf, как отдельное десктопное приложение (codex app) и как отдельная облачная версия под названием Codex Web.
Нужна ли подписка ChatGPT или можно использовать API-ключ?Codex работает с вашим тарифом ChatGPT Plus, Pro, Business, Edu или Enterprise через 'Sign in with ChatGPT', либо с ключом API OpenAI.
Так же просто использовать API-ключ, как войти через ChatGPT?Нет, работа Codex с API-ключом поддерживается, но требует дополнительной настройки по сравнению с простым входом через аккаунт ChatGPT.
На каких платформах это работает?Готовые бинарные файлы доступны для macOS (Apple Silicon и Intel/x86_64) и Linux (x86_64 и arm64); релиз для Windows не упоминается.
Что такое 'codex app'?Это десктопная версия Codex, которая запускается командой 'codex app' или скачивается с сайта и предоставляет графический интерфейс наряду с CLI для терминала.
Что такое Codex Web?Codex Web — это облачная версия агента для написания кода от OpenAI, отдельная от локально запущенного CLI, предназначенная для работы с Codex без установки чего-либо.
Можно ли использовать Codex прямо в редакторе кода?Да, Codex доступен как расширение для VS Code, Cursor и Windsurf, так что вы можете пользоваться тем же агентом, не выходя из редактора.
What are similar projects?billion-context, qwen-code, Baize, oh-my-pi, agent-router, continue, copperhead, openrig
Which topics is it in?ai-coding-agent, vscode, gpt, coding-agents, chatgpt, cli-tool, agents, command-line, coding-agent, ai-agent, openai, rust
Creator
openai
Size
668.9 MB
Stars
129.7K
Updated
CommitOct 18Releaserust-v0.163.0Oct 15
Age
1y
Commits · 90 Days