Yehowshua/ZIm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

More detail

Browse source
This commit is contained in:
Conrad Irwin 2025-08-25 15:33:01 -06:00
parent a570fe9692
commit a02f6bbfc9
2 changed files with 50 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/src/ai/agent-panel.md
View file

@ -9,7 +9,7 @@ You can do that by:
1. [subscribing to our Pro plan](https://zed.dev/pricing), so you have access to our hosted models
2. [bringing your own API keys](./llm-providers.md#use-your-own-keys) for your desired provider
3. using an external agent like [Gemini CLI](./gemini-cli.md)
3. using an external agent like [Gemini CLI](./external-agents.md#gemini-cli)
## Overview {#overview}

63
docs/src/ai/external-agents.md
View file

@ -1,35 +1,50 @@
# External Agents
Through the Agent Client Protocol (ACP), Zed can expose external agents that run as a subprocess.
Read the ACP documentation to learn how to add your agent to Zed.
Zed has support for integrating with existing terminal based agentic coding tools through the [Agent Client Protocol (ACP)](https://agentclientprotocol.com),
At the moment, Zed supports [Gemini CLI](https://github.com/google-gemini/gemini-cli) as a reference implementation of an external agent speaking ACP.
## Gemini CLI
You can also [configure your own](#custom-agents) if you'd like to add ACP support to an existing tool.
## Gemini CLI {#gemini-cli}
Zed provides the ability to run [Gemini CLI](https://github.com/google-gemini/gemini-cli) directly in the [agent panel](./agent-panel.md).
Under the hood we run Gemini CLI in the background, and talk to it over the [Agent Client Protocol (ACP)](https://agentclientprotocol.com).
Under the hood we run Gemini CLI in the background, and talk to it over ACP.
This means that you're running the real Gemini CLI, with all of the advantages of that, but you can see and interact with files in your editor.
### Getting Started
The Gemini integration should be enabled by default.
To access it, run `agent: new gemini cli thread`.
As of Zed Stable v0.201.5 you should be able to use Gemini CLI directly from Zed. First open the agent panel with {#kb agent::ToggleFocus}, and then use the `+` button in the top right to start a New Gemini CLI thread.
If you'd like to bind this to a keyboard shortcut, you can do so by editing your keybindings file to include:
```json
[
{
"bindings": {
"cmd-alt-g": ["agent::NewExternalAgentThread", { "agent": "gemini" }]
}
}
]
```
#### Installation
If you don't yet have Gemini CLI installed, then Zed will install a version for you.
If you do, then we will use the version of Gemini CLI on your path.
If you don't yet have Gemini CLI installed, then Zed will install a version for you. If you do, then we will use the version of Gemini CLI on your path.
If the version you haven installed is too old, you will see an error message, and you will have to upgrade Gemini CLI.
The instructions depend on how you originally installed it, but typically, running `npm install -g gemini-cli@preview` should work to fix it.
You need to be running at least Gemini version `0.2.0-preview`, and if your version of Gemini is too old you will see an
error message.
The instructions to upgrade Gemini depend on how you originally installed it, but typically, running `npm install -g gemini-cli@preview` should work.
#### Authentication
After you have Gemini CLI running, you'll be prompted to choose your authentication method.
Most users should click the "Log in with Google" button that will show up in the UI, but if you have an API key already you can also click "Use Gemini API Key".
Most users should click the "Log in with Google". This will cause a browser window to pop-up and auth directly with Gemini CLI. Zed does not see your oauth or access tokens in this case.
You can also use the "Gemini API Key". If you select this, and have the `GEMINI_API_KEY` set, then we will use that. Otherwise Zed will prompt you for an API key which will be stored securely in your keychain, and used to start Gemini CLI from within Zed.
The "Vertex AI" option is for those who are using Vertex AI, and have already configured their environment correctly.
@ -38,7 +53,27 @@ For more information, see the [Gemini CLI docs](https://github.com/google-gemini
### Usage
Similar to the built-in agent in [the agent panel](./agent-panel.md), you can use Gemini CLI to do anything that you need.
You can @-mention files, recent conversations, symbols, or fetch the web.
In this initial version, some features supported by the first-party agent are not avaialble for Gemini CLI.
Capacities such as editing previous messages, checkpoints, profile selection, and others should hopefully be added in the future.
There are two features that don't yet work with Gemini CLI: editing past messages, which we hope to add support for soon; and resuming a conversation from history.
## Custom Agents {#custom-agents}
If you have written (or are writing) a tool that speaks ACP, and you'd like to test it with Zed, you can add it to your settings:
```json
{
"agent_servers": {
"Claude Code": {
"command": "node",
"args": [
"/Users/conrad/projects/claude-code-acp/index.js",
"--acp"
]
}
}
}
```
Zed has some support for debugging acp connections, and you can open the debug view with `dev: open acp logs` from the command line.