Merge branch 'main' into fix/keep-config-model-for-custom-providers

Author: benbrandt

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      # Check for updates to GitHub Actions every week
+      interval: "weekly"
+    groups:
+      github-actions:
+        patterns:
+          - "*"

.github/workflows/ci.yml

@@ -14,11 +14,11 @@ jobs:
     permissions:
       contents: read
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v7
       - uses: actions/setup-node@v6
         with:
-          node-version: '24'
-      - uses: oven-sh/setup-bun@v2
+          node-version: "24"
+      - uses: oven-sh/setup-bun@0c5077e51419868618aeaa5fe8019c62421857d6
         with:
           bun-version: 1.3.11
       - name: Install dependencies

.github/workflows/codex-update.yml

@@ -2,17 +2,17 @@ name: Codex Update
 
 on:
   schedule:
-    - cron: '0 5 * * *' 
+    - cron: "0 5 * * *"
   workflow_dispatch:
 
 permissions:
   contents: read
   packages: read
 
 env:
-  CODEX_PACKAGE: '@openai/codex'
-  CODEX_UPDATE_LABEL: 'codex-update'
-  GITHUB_BOT_USERNAME: 'github-actions[bot]'
+  CODEX_PACKAGE: "@openai/codex"
+  CODEX_UPDATE_LABEL: "codex-update"
+  GITHUB_BOT_USERNAME: "github-actions[bot]"
 
 jobs:
   check:
@@ -22,7 +22,7 @@ jobs:
       version: ${{ steps.check.outputs.version }}
       branch: ${{ steps.check.outputs.branch }}
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v7
         with:
           fetch-depth: 0
 
@@ -58,13 +58,13 @@ jobs:
       VERSION: ${{ needs.check.outputs.version }}
     steps:
       - name: Generate GitHub token
-        uses: actions/create-github-app-token@v2
+        uses: actions/create-github-app-token@v3
         id: generate-token
         with:
           app-id: ${{ secrets.RELEASE_PLZ_APP_ID }}
           private-key: ${{ secrets.RELEASE_PLZ_APP_PRIVATE_KEY }}
 
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v7
         with:
           token: ${{ steps.generate-token.outputs.token }}
 
@@ -83,20 +83,20 @@ jobs:
 
       - name: Finalize update with Codex
         id: codex-finalize
-        uses: openai/codex-action@v1
+        uses: openai/codex-action@10cb888d2ed3b99867f7e7ccff174a861a75aeb6
         with:
           openai-api-key: ${{ secrets.OPENAI_API_KEY }}
           codex-version: ${{ env.VERSION }}
           output-file: pr-body.md
           codex-args: >-
             -c sandbox_workspace_write.writable_roots=["${{ github.workspace }}/.git"]
           prompt: >
-            Finalize the update using codex-update-compat skill. 
-            Commit the changes, the message should mention that types or/and tests after the update were fixed. 
+            Finalize the update using codex-update-compat skill.
+            Commit the changes, the message should mention that types or/and tests after the update were fixed.
             When creating the final message do not mention:
             * Validation run details.
             * Commits.
-            * Hyperlinks. 
+            * Hyperlinks.
             Mention only previously failed tests with failure reasons, also what you changed and why.
 
       - name: Push branch updates
@@ -143,4 +143,3 @@ jobs:
             gh pr close "$pr_number" \
               --comment "Closing obsolete update PR"
           done
- 

.github/workflows/e2e.yml

@@ -13,7 +13,7 @@ jobs:
     permissions:
       contents: read
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v7
       - uses: actions/setup-node@v6
         with:
           node-version: '24'

.github/workflows/publish.yml

@@ -14,7 +14,7 @@ jobs:
     permissions:
       contents: read
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v7
       - uses: actions/setup-node@v6
         with:
           node-version: '24'
@@ -42,7 +42,7 @@ jobs:
       contents: read
       id-token: write
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v7
       - uses: actions/setup-node@v6
         with:
           node-version: '24'
@@ -56,14 +56,14 @@ jobs:
     permissions: {}
     steps:
       - name: Generate GitHub token
-        uses: actions/create-github-app-token@v2
+        uses: actions/create-github-app-token@v3
         id: generate-token
         with:
           app-id: ${{ secrets.RELEASE_PLZ_APP_ID }}
           private-key: ${{ secrets.RELEASE_PLZ_APP_PRIVATE_KEY }}
 
       - name: Create Release
-        uses: softprops/action-gh-release@3bb12739c298aeb8a4eeaf626c5b8d85266b0e65 # v2.6.2
+        uses: softprops/action-gh-release@718ea10b132b3b2eba29c1007bb80653f286566b # v3.0.1
         with:
           token: ${{ steps.generate-token.outputs.token }}
           generate_release_notes: true

.github/workflows/version-bump.yml

@@ -19,13 +19,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Generate GitHub token
-        uses: actions/create-github-app-token@v2
+        uses: actions/create-github-app-token@v3
         id: generate-token
         with:
           app-id: ${{ secrets.RELEASE_PLZ_APP_ID }}
           private-key: ${{ secrets.RELEASE_PLZ_APP_PRIVATE_KEY }}
 
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v7
         with:
           token: ${{ steps.generate-token.outputs.token }}
 

README.md

@@ -1,7 +1,78 @@
 # ACP adapter for Codex CLI
+
 [![npm version](https://img.shields.io/npm/v/%40agentclientprotocol%2Fcodex-acp)](https://www.npmjs.com/package/@agentclientprotocol/codex-acp)
 
+Use [OpenAI Codex](https://github.com/openai/codex) from [Agent Client Protocol](https://agentclientprotocol.com/) clients.
+
+`codex-acp` is a stdio ACP agent server. It starts the Codex App Server, translates ACP requests into Codex operations, and maps Codex events back into the client.
+
+## Features
+
+- ChatGPT, API key, and client-provided custom gateway authentication.
+- Model, reasoning effort, fast mode, approval, and sandbox mode configuration.
+- Text prompts, embedded context, images, resource links, and additional workspace directories.
+- Shell command, file change, permission request, MCP tool call, terminal output, reasoning, plan, web search, image generation, image view, token usage, and review events.
+- Client-provided MCP servers over command-based stdio config and HTTP transport.
+- Slash commands: `/status`, `/mcp`, `/skills`, `/review`, `/review-branch`, `/review-commit`, `/compact`, and `/logout`, as well as configured skills.
+
+## Installation
+
+Run the published package directly:
+
+```bash
+npx -y @agentclientprotocol/codex-acp
+```
+
+Or install it globally:
+
+```bash
+npm install -g @agentclientprotocol/codex-acp
+codex-acp --version
+```
+
+The npm package includes a compatible `@openai/codex` dependency. Set `CODEX_PATH` only when you want the adapter to run a different Codex binary:
+
+```bash
+CODEX_PATH=/path/to/codex npx -y @agentclientprotocol/codex-acp
+```
+
+## Authentication
+
+The adapter advertises ACP auth methods during initialization. Clients can authenticate with:
+
+- ChatGPT login. Set `NO_BROWSER=1` to hide this method in remote or browserless environments.
+- API key via `CODEX_API_KEY` or `OPENAI_API_KEY`.
+- A custom OpenAI-compatible gateway, when the client opts in to the gateway auth capability.
+
+## Runtime options
+
+- `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.
+
+## Development
+
+```bash
+npm install
+npm run start
+npm run typecheck
+npm test
+```
+
+Build standalone binaries in `dist/bin` with:
+
+```bash
+npm run bundle:all
+```
+
+See [readme-dev.md](readme-dev.md) for local client configuration, binary packaging, and Codex type regeneration.
 
-## Documentation
+## License
 
-- **[Development Guide](readme-dev.md)** - Setup, configuration, and building binaries
+By contributing, you agree that your contributions will be licensed under the Apache 2.0 License.