1---
2title: Use Claude Agent, Gemini CLI, and Codex in Zed
3description: Run Claude Agent, Gemini CLI, Codex, and other AI coding agents directly in Zed via the Agent Client Protocol (ACP).
4---
5
6# External Agents
7
8Zed supports many external agents, including CLI-based ones, through the [Agent Client Protocol (ACP)](https://agentclientprotocol.com).
9
10Zed supports [Gemini CLI](https://github.com/google-gemini/gemini-cli) (the reference ACP implementation), [Claude Agent](https://platform.claude.com/docs/en/agent-sdk/overview), [Codex](https://developers.openai.com/codex), [GitHub Copilot](https://github.com/github/copilot-language-server-release), and [additional agents](#add-more-agents) you can configure.
11
12For Zed's built-in agent and the full list of tools it can use natively, see [Agent Tools](./tools.md).
13
14> Note that Zed's interaction with external agents is strictly UI-based; the billing, legal, and terms arrangement is directly between you and the agent provider.
15> Zed does not charge for use of external agents, and our [zero-data retention agreements/privacy guarantees](./ai-improvement.md) are **_only_** applicable for Zed's hosted models.
16
17## Gemini CLI {#gemini-cli}
18
19Zed provides the ability to run [Gemini CLI](https://github.com/google-gemini/gemini-cli) directly in the [agent panel](./agent-panel.md).
20Under the hood we run Gemini CLI in the background, and talk to it over ACP.
21
22### Getting Started
23
24First open the agent panel with {#kb agent::ToggleFocus}, and then use the `+` button in the top right to start a new Gemini CLI thread.
25
26If you'd like to bind this to a keyboard shortcut, you can do so by editing your `keymap.json` file via the `zed: open keymap file` command to include:
27
28```json [keymap]
29[
30 {
31 "bindings": {
32 "cmd-alt-g": [
33 "agent::NewExternalAgentThread",
34 { "agent": { "custom": { "name": "gemini" } } }
35 ]
36 }
37 }
38]
39```
40
41#### Installation
42
43The first time you create a Gemini CLI thread, Zed will install [@google/gemini-cli](https://github.com/google-gemini/gemini-cli).
44This installation is only available to Zed and is kept up to date as you use the agent.
45
46#### Authentication
47
48After you have Gemini CLI running, you'll be prompted to authenticate.
49
50Click the "Login" button to open the Gemini CLI interactively, where you can log in with your Google account or [Vertex AI](https://cloud.google.com/vertex-ai) credentials.
51Zed does not see your OAuth or access tokens in this case.
52
53If the `GEMINI_API_KEY` environment variable (or `GOOGLE_AI_API_KEY`) is already set, or you have configured a Google AI API key in Zed's [language model provider settings](./llm-providers.md#google-ai), it will be passed to Gemini CLI automatically.
54
55For more information, see the [Gemini CLI docs](https://github.com/google-gemini/gemini-cli/blob/main/docs/index.md).
56
57### Usage
58
59Gemini CLI supports the same workflows as Zed's first-party agent: code generation, refactoring, debugging, and Q&A. Add context by @-mentioning files, recent threads, or symbols.
60
61> Some agent panel features are not yet available with Gemini CLI: editing past messages, resuming threads from history, and checkpointing.
62
63## Claude Agent
64
65Similar to Gemini CLI, you can also run [Claude Agent](https://platform.claude.com/docs/en/agent-sdk/overview) directly via Zed's [agent panel](./agent-panel.md).
66Under the hood, Zed runs the Claude Agent SDK, which runs Claude Code under the hood, and communicates to it over ACP, through [a dedicated adapter](https://github.com/zed-industries/claude-agent-acp).
67
68### Getting Started
69
70Open the agent panel with {#kb agent::ToggleFocus}, and then use the `+` button in the top right to start a new Claude Agent thread.
71
72If you'd like to bind this to a keyboard shortcut, you can do so by editing your `keymap.json` file via the `zed: open keymap file` command to include:
73
74```json [keymap]
75[
76 {
77 "bindings": {
78 "cmd-alt-c": [
79 "agent::NewExternalAgentThread",
80 { "agent": { "custom": { "name": "claude-acp" } } }
81 ]
82 }
83 }
84]
85```
86
87### Authentication
88
89As of version `0.202.7`, authentication to Zed's Claude Agent installation is decoupled entirely from Zed's agent.
90That is to say, an Anthropic API key added via the [Zed Agent's settings](./llm-providers.md#anthropic) will _not_ be utilized by Claude Agent for authentication and billing.
91
92To ensure you're using your billing method of choice, [open a new Claude Agent thread](./agent-panel.md#new-thread).
93Then, run `/login`, and authenticate either via API key, or via `Log in with Claude Code` to use a Claude Pro/Max subscription.
94
95#### Installation
96
97The first time you create a Claude Agent thread, Zed will install [@zed-industries/claude-agent-acp](https://github.com/zed-industries/claude-agent-acp).
98This installation is only available to Zed and is kept up to date as you use the agent.
99
100Zed will always use this managed version of the Claude Agent adapter, which includes a vendored version of the Claude Code CLI, even if you have it installed globally.
101
102If you want to override the executable used by the adapter, you can set the `CLAUDE_CODE_EXECUTABLE` environment variable in your settings to the path of your preferred executable.
103
104```json
105{
106 "agent_servers": {
107 "claude-acp": {
108 "type": "registry",
109 "env": {
110 "CLAUDE_CODE_EXECUTABLE": "/path/to/alternate-claude-code-executable"
111 }
112 }
113 }
114}
115```
116
117### Usage
118
119Claude Agent supports the same workflows as Zed's first-party agent. Add context by @-mentioning files, recent threads, diagnostics, or symbols.
120
121In complement to talking to it [over ACP](https://agentclientprotocol.com), Zed relies on the [Claude Agent SDK](https://platform.claude.com/docs/en/agent-sdk/overview) to support some of its specific features.
122However, the SDK doesn't yet expose everything needed to fully support all of them:
123
124- Slash Commands: [Custom slash commands](https://code.claude.com/docs/en/slash-commands#custom-slash-commands) are fully supported, and have been merged into skills. A subset of [built-in commands](https://code.claude.com/docs/en/slash-commands#built-in-slash-commands) are supported.
125- [Subagents](https://code.claude.com/docs/en/sub-agents) are supported.
126- [Agent teams](https://code.claude.com/docs/en/agent-teams) are currently _not_ supported.
127- [Hooks](https://code.claude.com/docs/en/hooks-guide) are currently _not_ supported.
128
129> Some [agent panel](./agent-panel.md) features are not yet available with Claude Agent: editing past messages, resuming threads from history, and checkpointing.
130
131#### CLAUDE.md
132
133Claude Agent in Zed will automatically use any `CLAUDE.md` file found in your project root, project subdirectories, or root `.claude` directory.
134
135If you don't have a `CLAUDE.md` file, you can ask Claude Agent to create one for you through the `init` slash command.
136
137## Codex CLI
138
139You can also run [Codex CLI](https://github.com/openai/codex) directly via Zed's [agent panel](./agent-panel.md).
140Under the hood, Zed runs Codex CLI and communicates to it over ACP, through [a dedicated adapter](https://github.com/zed-industries/codex-acp).
141
142### Getting Started
143
144As of version `0.208`, you should be able to use Codex directly from Zed.
145Open the agent panel with {#kb agent::ToggleFocus}, and then use the `+` button in the top right to start a new Codex thread.
146
147If you'd like to bind this to a keyboard shortcut, you can do so by editing your `keymap.json` file via the `zed: open keymap file` command to include:
148
149```json
150[
151 {
152 "bindings": {
153 "cmd-alt-c": [
154 "agent::NewExternalAgentThread",
155 { "agent": { "custom": { "name": "codex-acp" } } }
156 ]
157 }
158 }
159]
160```
161
162### Authentication
163
164Authentication to Zed's Codex installation is decoupled entirely from Zed's agent.
165That is to say, an OpenAI API key added via the [Zed Agent's settings](./llm-providers.md#openai) will _not_ be utilized by Codex for authentication and billing.
166
167To ensure you're using your billing method of choice, [open a new Codex thread](./agent-panel.md#new-thread).
168The first time you will be prompted to authenticate with one of three methods:
169
1701. Login with ChatGPT - allows you to use your existing, paid ChatGPT subscription. _Note: This method isn't currently supported in remote projects_
1712. `CODEX_API_KEY` - uses an API key you have set in your environment under the variable `CODEX_API_KEY`.
1723. `OPENAI_API_KEY` - uses an API key you have set in your environment under the variable `OPENAI_API_KEY`.
173
174If you are already logged in and want to change your authentication method, type `/logout` in the thread and authenticate again.
175
176If you want to use a third-party provider with Codex, you can configure that with your [Codex config.toml](https://github.com/openai/codex/blob/main/docs/config.md#model-selection) or pass extra [args/env variables](https://github.com/openai/codex/blob/main/docs/config.md#model-selection) to your Codex agent servers settings.
177
178#### Installation
179
180The first time you create a Codex thread, Zed will install [codex-acp](https://github.com/zed-industries/codex-acp).
181This installation is only available to Zed and is kept up to date as you use the agent.
182
183Zed will always use this managed version of Codex even if you have it installed globally.
184
185### Usage
186
187Codex supports the same workflows as Zed's first-party agent. Add context by @-mentioning files or symbols.
188
189> Some agent panel features are not yet available with Codex: editing past messages, resuming threads from history, and checkpointing.
190
191## Add More Agents {#add-more-agents}
192
193### Via Agent Server Extensions
194
195<div class="warning">
196
197Starting from `v0.221.x`, [the ACP Registry](https://agentclientprotocol.com/registry) is the preferred way to install external agents in Zed.
198Learn more about it in [the release blog post](https://zed.dev/blog/acp-registry).
199At some point in the near future, Agent Server extensions will be deprecated.
200
201</div>
202
203Add more external agents to Zed by installing [Agent Server extensions](../extensions/agent-servers.md).
204
205See what agents are available by filtering for "Agent Servers" in the extensions page, which you can access via the command palette with `zed: extensions`, or the [Zed website](https://zed.dev/extensions?filter=agent-servers).
206
207### Via The ACP Registry
208
209#### Overview
210
211As mentioned above, the Agent Server extensions will be deprecated in the near future to give room to the ACP Registry.
212
213[The ACP Registry](https://github.com/agentclientprotocol/registry) lets developers distribute ACP-compatible agents to any client that implements the protocol. Agents installed from the registry update automatically.
214
215At the moment, the registry is a curated set of agents, including only the ones that [support authentication](https://agentclientprotocol.com/rfds/auth-methods).
216
217#### Using it in Zed
218
219Use the `zed: acp registry` command to quickly go to the ACP Registry page.
220There's also a button ("Add Agent") that takes you there in the agent panel's configuration view.
221
222From there, you can click to install your preferred agent and it will become available right away in the `+` icon button in the agent panel.
223
224> If you installed the same agent through both the extension and the registry, the registry version takes precedence.
225
226### Custom Agents
227
228You can also add agents through your settings file ([how to edit](../configuring-zed.md#settings-files)) by specifying certain fields under `agent_servers`, like so:
229
230```json [settings]
231{
232 "agent_servers": {
233 "My Custom Agent": {
234 "type": "custom",
235 "command": "node",
236 "args": ["~/projects/agent/index.js", "--acp"],
237 "env": {}
238 }
239 }
240}
241```
242
243This can be useful if you're in the middle of developing a new agent that speaks the protocol and you want to debug it.
244
245It's also possible to customize environment variables for registry-installed agents like Claude Agent, Codex, and Gemini CLI by using their registry names (`claude-acp`, `codex-acp`, `gemini`) with `"type": "registry"` in your settings.
246
247## Debugging Agents
248
249When using external agents in Zed, you can access the debug view via with `dev: open acp logs` from the Command Palette.
250This lets you see the messages being sent and received between Zed and the agent.
251
252
253
254It's helpful to attach data from this view if you're opening issues about problems with external agents like Claude Agent, Codex, OpenCode, etc.
255
256## MCP Servers
257
258Note that for external agents, access to MCP servers [installed from Zed](./mcp.md) may vary depending on the ACP implementation.
259For example, Claude Agent and Codex both support it, but Gemini CLI does not yet.