Skip to content

docs: add Xcode IDE integration guide #642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
youngxhui wants to merge 1 commit into
base: main
Choose a base branch
from
+32 −0
Open

docs: add Xcode IDE integration guide #642

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/en/guides/ides.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,22 @@ Pick **Kimi Code CLI** from Paseo's built-in ACP provider catalog, or add a cust

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`.

## Using Kimi Code CLI in Xcode

[Xcode](https://developer.apple.com/xcode/) is Apple's official integrated development environment (IDE) for building macOS, iOS, watchOS, tvOS, and visionOS apps. It integrates a complete workflow covering code editing, interface building, debugging, performance analysis, and App Store distribution.

ACP is available in Xcode 26.6 and later. Open `Settings...`, go to `Intelligence`, select `Add an Agent...`, and fill in the following configuration:
Comment thread
youngxhui marked this conversation as resolved.

| Property | Value |
| ---------- | ----------------- |
| Name | kimi-code |
| Executable | ~/.local/bin/kimi |
| Arguments | acp |

It is recommended to use an absolute path for `Executable`, because child processes launched from the Xcode GUI typically do not inherit the terminal's `PATH`. You can get the path by running `which kimi` in a terminal.

After completing the configuration, you will see Kimi in the `Coding Assistant`.

## 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`).
Expand Down
16 changes: 16 additions & 0 deletions docs/zh/guides/ides.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,22 @@ JetBrains 这一侧对 `command` 字段处理较严格——务必填写**绝对

Paseo 的通用 ACP 适配层不会帮你走登录流程，所以请先完成终端登录（见[前置准备](#前置准备)）——否则创建会话会以 `Authentication required` 失败。

## 在 Xcode 中使用

[Xcode](https://developer.apple.com/xcode/) 是 Apple 官方的集成开发环境（IDE），用于开发 macOS、iOS、watchOS、tvOS 和 visionOS 应用，集成了代码编辑、界面构建、调试、性能分析和 App Store 发布等全流程工具。

在 Xcode 26.6 及以上版本提供 ACP 接入。在 `Settings...` 中的 `Intelligence` 中，选择 `Add an Agent...` ，填写以下配置。

| 属性名 | 属性值 |
| ---------- | ----------------- |
| Name | kimi-code |
| Executable | ~/.local/bin/kimi |
| Arguments | acp |

`Executable` 建议填写绝对路径，因为 Xcode GUI 启动的子进程通常不会继承终端的 `PATH`,可以在终端执行 `which kimi` 拿到。

配置完成之后，可以在 `Coding Assistant` 中看到 Kimi 。

## 故障排查

- **会话立刻被中断 / IDE 提示 "agent exited"**：通常是 `command` 路径不对或 kimi 没登录。先在终端跑一次 `kimi acp` 验证：如果阻塞等待标准输入则说明 CLI 本身没问题，问题在 IDE 配置；如果立刻报错则按报错提示处理（多数是没 `/login`）。
Expand Down