readme-dev.md

This package uses the bundled @openai/codex dependency by default. Set CODEX_PATH to run a different Codex binary; versions other than the one specified in package.json may not be compatible.

Quick start

Develop on Windows?

• Download and install C++ redistributable package

Adjust ACP client config

Run from sources

1. Install dependencies npm install
2. Adjust ACP client config

{
  "agent_servers": {
    "Codex (app-server)": {
      "command": "npm",
      "args": ["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

1. Download a codex-acp-<platform>.zip archive from https://github.com/agentclientprotocol/codex-acp/releases
2. Unzip the archive:

   unzip codex-acp-<platform>.zip

3. Adjust ACP client config

{
  "agent_servers": {
    "Codex (app-server)": {
      "command": "/path/to/codex-acp",
      "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

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