Skip to content

Latest commit

 

History

History
61 lines (42 loc) · 1.44 KB

File metadata and controls

61 lines (42 loc) · 1.44 KB

ACP adapter for Codex

Use Codex from ACP-compatible clients such as Zed!

This tool implements an ACP adapter around the Codex CLI, supporting:

  • Context @-mentions
  • Images
  • Tool calls (with permission requests)
  • Following
  • Edit review
  • TODO lists
  • Slash commands:
    • /review (with optional instructions)
    • /review-branch
    • /review-commit
    • /init
    • /compact
    • /logout
    • Custom Prompts
  • Client MCP servers
  • Auth Methods:
    • ChatGPT subscription (requires paid subscription and doesn't work in remote projects)
    • CODEX_API_KEY
    • OPENAI_API_KEY

Learn more about the Agent Client Protocol.

How to use

Zed

The latest version of Zed can already use this adapter out of the box.

To use Codex, open the Agent Panel and click "New Codex Thread" from the + button menu in the top-right.

Read the docs on External Agent support.

Other clients

Or try it with any of the other ACP compatible clients!

Installation

Install the adapter from the latest release for your architecture and OS: https://github.com/zed-industries/codex-acp/releases

You can then use codex-acp as a regular ACP agent:

OPENAI_API_KEY=sk-... codex-acp

Or via npm:

npx @zed-industries/codex-acp

License

Apache-2.0