Skip to content

README.md

Latest commit

 

History

History
112 lines (74 loc) · 3.83 KB

README.md

File metadata and controls

112 lines (74 loc) · 3.83 KB

Kontext Codex CLI

Install:

npm i -g @kontext-dev/codex

@kontext-dev/codex is the Kontext-maintained Codex CLI fork with baked Kontext OAuth + MCP defaults.

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-kontext 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.

Kontext-Dev fork

This fork wires Codex CLI to the Kontext-Dev MCP server using the kontext-dev-sdk Rust SDK. It authenticates with PKCE, exchanges tokens for mcp-gateway, and attaches a single MCP server automatically.

Configuration

This fork uses baked Kontext defaults. No [kontext-dev] block is required in ~/.codex/config.toml.

Built-in values:

  • client_id: baked into this fork
  • redirect_uri: http://localhost:3333/callback
  • server: https://api.kontext.dev/mcp
  • resource: mcp-gateway
  • integration_ui_url: https://app.kontext.dev
  • open_connect_page_on_login: true

Running locally

cd codex-rs
cargo run --bin codex

Branch model: main mirrors openai/codex, and kontext-dev carries Kontext customizations on top of main.

Versioning

This fork follows upstream base versions with a Kontext release suffix:

  • format: <upstream_version>-kontext.<N>
  • example: 0.105.0-kontext.1

N increments for fork-only releases on top of the same upstream base version.

Quickstart

Installing and running Codex CLI

Configure npm for GitHub Packages and install globally:

# Authenticate to GitHub Packages (@kontext-dev scope)
npm config set @kontext-dev:registry https://npm.pkg.github.com
npm config set //npm.pkg.github.com/:_authToken YOUR_GITHUB_PAT

# Install the private fork package
npm install -g @kontext-dev/codex

Then run codex-kontext 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-kontext and select Sign in with ChatGPT. We recommend signing into your ChatGPT account to use Codex as part of your Plus, Pro, Team, 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.

First-run Kontext flow

After Codex login completes, this fork automatically runs Kontext PKCE. If your integrations are disconnected, the Kontext connect page opens automatically. On later runs, prompts only reappear when token or integration state changes.

Docs

This repository is licensed under the Apache-2.0 License.