readme-dev.md

April 21, 2026 · View on GitHub

This package lists codex only as a dev dependency and requires the codex binary. It may not work with versions other than the one specified in package.json.

Quick start

Develop on Windows?

Download and install C++ redistributable package

Adjust acp config for IDE

Run from sources

Install dependencies npm install
Adjust acp config for IDE

{
  "agent_servers": {
    "Codex (app-server)": {
      "command": "npx",
      "args": [
        "npm",
        "run",
        "start",
        "--prefix",
        "/path/to/project/"
      ],
      "env": {
        "CODEX_PATH": "node_modules/.bin/codex",
        "APP_SERVER_LOGS": "optional/path/to/existing/log/directory"
      }
    }
  }
}

Run from binaries

Download acp-server binary archive from https://github.com/JetBrains/codex-acp/tags
Unzip the archive:
```
unzip codex-acp-<platform>.zip
```
Adjust acp config for IDE

{
  "agent_servers": {
    "Codex (app-server)": {
      "command": "/path/to/acp-server",
      "env": {
        "CODEX_PATH": "/path/to/codex"
      }
    }
  }
}

Build binaries

Building standalone binaries requires bun.

Build single-file executables in dist/bin directory:

npm run bundle:all

Package binaries into zip archives:

npm run package:all

Update supported Codex version

Update Codex dependency: package.json
Regenerate Codex types in src/app-server/: npm run generate-types
Ensure there are no type errors or failed tests: npm run typecheck and npm run test