Skip to content

readme-dev.md

Latest commit

 

History

History
86 lines (66 loc) · 2.53 KB

readme-dev.md

File metadata and controls

86 lines (66 loc) · 2.53 KB
Raw

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.

Runtime environment

  • CODEX_API_KEY - API key used when the API-key auth method is selected. Takes precedence over OPENAI_API_KEY.
  • OPENAI_API_KEY - fallback API key used when the API-key auth method is selected.
  • CODEX_PATH - run a specific Codex executable instead of the bundled package dependency.
  • CODEX_CONFIG - JSON object merged into the Codex session config.
  • MODEL_PROVIDER - model provider to pass to Codex for new sessions.
  • DEFAULT_AUTH_REQUEST - ACP auth request JSON used when Codex requires authentication.
  • INITIAL_AGENT_MODE - initial mode id: read-only, agent, or agent-full-access.
  • NO_BROWSER - hide browser-based ChatGPT auth when set.
  • APP_SERVER_LOGS - directory for adapter logs.

Quick start

Develop on Windows?

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 (<platform> is one of: linux, darwin, win32)
  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 the @openai/codex version in package.json (under dependencies).
  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