@agentclientprotocol/codex-acp 0.0.46 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +73 -2
- package/dist/index.js +14524 -7861
- package/package.json +6 -5
package/README.md
CHANGED
|
@@ -1,7 +1,78 @@
|
|
|
1
1
|
# ACP adapter for Codex CLI
|
|
2
|
+
|
|
2
3
|
[](https://www.npmjs.com/package/@agentclientprotocol/codex-acp)
|
|
3
4
|
|
|
5
|
+
Use [OpenAI Codex](https://github.com/openai/codex) from [Agent Client Protocol](https://agentclientprotocol.com/) clients.
|
|
6
|
+
|
|
7
|
+
`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.
|
|
8
|
+
|
|
9
|
+
## Features
|
|
10
|
+
|
|
11
|
+
- ChatGPT, API key, and client-provided custom gateway authentication.
|
|
12
|
+
- Model, reasoning effort, fast mode, approval, and sandbox mode configuration.
|
|
13
|
+
- Text prompts, embedded context, images, resource links, and additional workspace directories.
|
|
14
|
+
- Shell command, file change, permission request, MCP tool call, terminal output, reasoning, plan, web search, image generation, image view, token usage, and review events.
|
|
15
|
+
- Client-provided MCP servers over command-based stdio config and HTTP transport.
|
|
16
|
+
- Slash commands: `/status`, `/mcp`, `/skills`, `/review`, `/review-branch`, `/review-commit`, `/compact`, and `/logout`, as well as configured skills.
|
|
17
|
+
|
|
18
|
+
## Installation
|
|
19
|
+
|
|
20
|
+
Run the published package directly:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npx -y @agentclientprotocol/codex-acp
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Or install it globally:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
npm install -g @agentclientprotocol/codex-acp
|
|
30
|
+
codex-acp --version
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
The npm package includes a compatible `@openai/codex` dependency. Set `CODEX_PATH` only when you want the adapter to run a different Codex binary:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
CODEX_PATH=/path/to/codex npx -y @agentclientprotocol/codex-acp
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Authentication
|
|
40
|
+
|
|
41
|
+
The adapter advertises ACP auth methods during initialization. Clients can authenticate with:
|
|
42
|
+
|
|
43
|
+
- ChatGPT login. Set `NO_BROWSER=1` to hide this method in remote or browserless environments.
|
|
44
|
+
- API key via `CODEX_API_KEY` or `OPENAI_API_KEY`.
|
|
45
|
+
- A custom OpenAI-compatible gateway, when the client opts in to the gateway auth capability.
|
|
46
|
+
|
|
47
|
+
## Runtime options
|
|
48
|
+
|
|
49
|
+
- `CODEX_API_KEY` - API key used when the API-key auth method is selected. Takes precedence over `OPENAI_API_KEY`.
|
|
50
|
+
- `OPENAI_API_KEY` - fallback API key used when the API-key auth method is selected.
|
|
51
|
+
- `CODEX_PATH` - run a specific Codex executable instead of the bundled package dependency.
|
|
52
|
+
- `CODEX_CONFIG` - JSON object merged into the Codex session config.
|
|
53
|
+
- `MODEL_PROVIDER` - model provider to pass to Codex for new sessions.
|
|
54
|
+
- `DEFAULT_AUTH_REQUEST` - ACP auth request JSON used when Codex requires authentication.
|
|
55
|
+
- `INITIAL_AGENT_MODE` - initial mode id: `read-only`, `agent`, or `agent-full-access`.
|
|
56
|
+
- `NO_BROWSER` - hide browser-based ChatGPT auth when set.
|
|
57
|
+
- `APP_SERVER_LOGS` - directory for adapter logs.
|
|
58
|
+
|
|
59
|
+
## Development
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
npm install
|
|
63
|
+
npm run start
|
|
64
|
+
npm run typecheck
|
|
65
|
+
npm test
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Build standalone binaries in `dist/bin` with:
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
npm run bundle:all
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
See [readme-dev.md](readme-dev.md) for local client configuration, binary packaging, and Codex type regeneration.
|
|
4
75
|
|
|
5
|
-
##
|
|
76
|
+
## License
|
|
6
77
|
|
|
7
|
-
|
|
78
|
+
By contributing, you agree that your contributions will be licensed under the Apache 2.0 License.
|