|
Download docs/en/guides/ides.md from SaylorTwift/kimi-code: direct link, hf CLI and curl.
- Browser
- Download file 4.53 kB
-
https://huggingface.co/SaylorTwift/kimi-code/resolve/main/docs/en/guides/ides.md
- Command line
-
hf download hf://SaylorTwift/kimi-code/docs/en/guides/ides.md
-
curl -L -o ides.md https://huggingface.co/SaylorTwift/kimi-code/resolve/main/docs/en/guides/ides.md
4.53 kB
| # Using Kimi Code CLI in IDEs | |
| Kimi Code CLI supports integration into IDEs via the [Agent Client Protocol (ACP)](https://agentclientprotocol.com/), letting you use AI-assisted coding directly inside your editor. | |
| ## Prerequisites | |
| Before configuring your IDE, make sure Kimi Code CLI is installed and you have completed the login setup. | |
| The ACP server is exposed as the `kimi acp` subcommand. The IDE launches it as a child process and communicates over stdin/stdout using JSON-RPC. Each time the IDE creates a session, the CLI reuses its existing authentication state β no need to log in again. | |
| ::: tip Path note | |
| Child processes launched from an IDE GUI on macOS typically do **not** inherit the terminal shell's `PATH`. If `kimi` is not in a system directory like `/usr/local/bin`, use the absolute path in your IDE configuration. Run `which kimi` in a terminal to find the active path. | |
| ::: | |
| ## Using Kimi Code CLI in Zed | |
| [Zed](https://zed.dev/) is a modern editor with native ACP support. | |
| Add the following to Zed's config file at `~/.config/zed/settings.json`: | |
| ```json | |
| { | |
| "agent_servers": { | |
| "Kimi Code CLI": { | |
| "type": "custom", | |
| "command": "kimi", | |
| "args": ["acp"], | |
| "env": {} | |
| } | |
| } | |
| } | |
| ``` | |
| Configuration fields: | |
| - `type`: fixed value `"custom"` | |
| - `command`: path to the Kimi Code CLI executable. If `kimi` is not on `PATH`, use the full path (e.g. `/Users/you/.local/bin/kimi`). | |
| - `args`: startup arguments. The `acp` subcommand switches the CLI into ACP mode. | |
| - `env`: additional environment variables; usually leave this empty. Zed injects a default environment automatically. | |
| After saving, open a new conversation in Zed's Agent panel and it will launch a `Kimi Code CLI` ACP subprocess using the configuration above. MCP servers declared in Zed's `agent_servers` section are also forwarded to the kimi side via the ACP protocol. | |
| ## Using Kimi Code CLI in JetBrains IDEs | |
| JetBrains IDEs (IntelliJ IDEA, PyCharm, WebStorm, etc.) support ACP through the AI chat plugin. | |
| If you do not have a JetBrains AI subscription, you can enable `llm.enable.mock.response` in the Registry to access the AI chat panel in ACP-only scenarios. Press Shift twice and search for "Registry" to open it. | |
| In the AI chat panel menu, click **Configure ACP agents** and add the following configuration: | |
| ```json | |
| { | |
| "agent_servers": { | |
| "Kimi Code CLI": { | |
| "command": "~/.local/bin/kimi", | |
| "args": ["acp"], | |
| "env": {} | |
| } | |
| } | |
| } | |
| ``` | |
| JetBrains is strict about the `command` field β always use an **absolute path**, which you can get by running `which kimi` in a terminal. After saving, `Kimi Code CLI` will appear in the AI chat's agent selector. | |
| ## Using Kimi Code CLI in Paseo | |
| [Paseo](https://paseo.sh/) is a self-hosted orchestrator that runs and supervises agent CLIs from your desktop, web, and mobile. It connects to Kimi Code CLI over ACP, the same way an IDE does. | |
| Pick **Kimi Code CLI** from Paseo's built-in ACP provider catalog, or add a custom provider in `~/.paseo/config.json`: | |
| ```json | |
| { | |
| "agents": { | |
| "providers": { | |
| "kimi": { | |
| "extends": "acp", | |
| "label": "Kimi Code CLI", | |
| "command": ["kimi", "acp"] | |
| } | |
| } | |
| } | |
| } | |
| ``` | |
| Paseo's generic ACP adapter does not drive the login flow, so complete the terminal login first (see [Prerequisites](#prerequisites)) β otherwise session creation fails with `Authentication required`. | |
| ## Troubleshooting | |
| - **Session disconnects immediately / IDE shows "agent exited"**: usually a wrong `command` path or a missing login. Run `kimi acp` in a terminal first to verify β if it blocks waiting for stdin, the CLI itself is fine and the problem is in the IDE configuration; if it exits immediately with an error, follow the error message (most commonly you need to run `/login`). | |
| - **IDE shows "auth required"**: the CLI has no usable authentication token. Exit the IDE, run `kimi` in a terminal to complete login, then restart the IDE. | |
| - **MCP tools not visible**: check the [`kimi acp` reference](../reference/kimi-acp.md) capability table to confirm that the MCP transport type configured in your IDE is supported. The Kimi Code CLI ACP server currently supports `http`, `stdio`, and `sse` transports; `acp` transport MCP servers are silently dropped and a warning is written to the log. | |
| ## Next steps | |
| - [kimi acp reference](../reference/kimi-acp.md) β ACP capability matrix and method coverage details | |
| - [kimi command reference](../reference/kimi-command.md) β full subcommand list | |