mirror of
https://github.com/MoonshotAI/kimi-code.git
synced 2026-08-09 08:48:22 +00:00
* feat(plugin): install plugins from a GitHub repository URL Allow `/plugins install <github-url>` (and marketplace `source` entries) to take a GitHub repo URL directly. A new `github` source kind joins the existing `local-path` and `zip-url` kinds. Recognized URL forms (parsing in source.ts): - `https://github.com/<o>/<r>` — bare; resolves to latest release tag, falling back to default branch HEAD. - `https://github.com/<o>/<r>/tree/<ref>` — branch / tag / SHA; value passed to codeload in its short form so the backend resolves either. - `https://github.com/<o>/<r>/releases/tag/<tag>` — explicit tag, uses refs/tags/<tag> to avoid same-named-branch ambiguity. - `https://github.com/<o>/<r>/commit/<sha>` — explicit commit SHA. The resolver deliberately avoids `api.github.com`: its 60/hour anonymous quota is shared with every other tool on the egress IP (browser, gh CLI, IDE integrations) and a first-time install failing because some other tool ate the budget is unacceptable UX. Instead we: - GET `github.com/<o>/<r>/releases/latest` with manual redirect and parse the `Location` header (302 → tag URL; 404 → no own release). - Fall back to `codeload.github.com/<o>/<r>/zip/HEAD` for repos with no releases (or for forks that inherit upstream tags but have no own release page, which redirect to bare `/releases`). - Only treat the explicit 404 from `/releases/latest` as "no release" — 5xx, 403, 429, and any other non-2xx status surface a hard error rather than silently installing the default branch, so the user knows when transient GitHub issues changed the install path. UI changes in the TUI: - `/plugins install` now shows a live Braille spinner while resolving and downloading, then flips to a final status that distinguishes Installed (fresh) vs Updated (same repo identity, new version) vs Migrated (source changed, e.g. CDN zip-url → GitHub). - `/plugins list`, the `/plugins` overview, and `/plugins info` show the install provenance inline. `zip-url` installs now display the URL host (e.g. `via code.kimi.com`, `via 127.0.0.1:port`) instead of the opaque `zip-url` literal. GitHub installs show `github <owner>/<repo>@<ref>`. - Three-tier trust badge driven by the marketplace context recorded at install time: `official` (green) for `tier: official`, `curated` (blue) for `tier: curated`, `third-party` (muted) for anything not installed through the marketplace selector. CLI `/plugins install <url>` always records as third-party; the marketplace selector passes the tier through. A re-install replaces the marketplace context: switching to a third-party source clears the badge, which matches the underlying trust change. `installed.json` gains optional `github` and `marketplace` fields (back-compatible). PluginSummary surfaces `source`, `originalSource`, `github`, and `marketplace` so the TUI can label installs without an extra round trip to PluginInfo. The SDK's `session.installPlugin(source)` gains an optional `{ marketplace }` second argument so the marketplace selector can forward `{ id, tier }` through RPC; the CLI install path omits it. Tests: 112 plugin-suite tests (URL parser, resolver, store round-trip, manager integration). The manager integration tests assert codeload URLs shape (short form for `/tree/<ref>`, explicit `refs/tags/` for `/releases/tag/`) and verify marketplace context is persisted across reloads and cleared on a third-party re-install. * chore(changeset): plugin install from GitHub * docs(plugins): document GitHub install URLs and trust badges * fix(plugin): preserve URL-encoded characters in GitHub ref names Git permits ref characters that have special meaning in URLs — most notably `#`, which is a valid tag character (e.g. `release#1`) but the URL fragment delimiter. The resolver decoded the tag from GitHub's `/releases/latest` 302 redirect Location header and then interpolated the raw value into the codeload URL. The literal `#1` became a fragment and the HTTP request reached the server as `…/refs/tags/release` — a wrong or truncated ref, leading to install failure for a release whose URL was otherwise valid. Two symmetric changes: - The codeload URL builder now splits the ref on `/` (so multi-segment refs like `feat/foo` keep their path separators) and percent-encodes each segment. - The GitHub URL parser now percent-decodes each segment from the URL's pathname when extracting `/tree/<ref>`, `/releases/tag/<tag>`, and `/commit/<sha>`. Storage and display see the human-readable Git ref name; the resolver re-encodes on the way out. Malformed `%xx` sequences in user-typed URLs are tolerated: we keep the raw segment so the caller surfaces a normal "ref not found" error downstream instead of crashing during parse. * fix: restrict plugin trust badges * chore: remove fetch when show plugin list --------- Co-authored-by: qer <Anna_Knapprfr@mail.com>
159 lines
7.9 KiB
Markdown
159 lines
7.9 KiB
Markdown
# Plugins
|
||
|
||
Plugins 把可复用的 Kimi Code CLI 能力打包成可安装单元。一个 plugin 可以添加 [Agent Skills](./skills.md),在会话启动时加载指定 Skill,也可以声明 MCP servers 来提供真实工具能力。
|
||
|
||
当你需要共享工作流、连接外部服务,或从官方 marketplace 安装扩展时,可以使用 plugins。Kimi Code CLI 对 plugin 采用保守的加载策略:安装 plugin 不会执行其中的 Python、Node.js、Shell、hook 或命令脚本。
|
||
|
||
## 安装与管理 plugins
|
||
|
||
在 TUI 中运行 `/plugins` 可打开 plugin 管理器。你可以在这里安装 plugins、浏览官方 marketplace、查看 plugin 详情、启用或禁用 plugins、移除 plugins、重载安装记录,以及管理 plugin 的 MCP servers。
|
||
|
||
常用按键:
|
||
|
||
| 按键 | 操作 |
|
||
| --- | --- |
|
||
| `Enter` 或 `→` | 打开选中项,或安装 marketplace 中选中的 plugin。 |
|
||
| `Space` | 启用或禁用已安装 plugin;在 marketplace 中安装或更新 plugin。 |
|
||
| `M` | 管理选中 plugin 的 MCP servers。 |
|
||
| `←` 或 `Esc` | 返回上一层。 |
|
||
|
||
多数情况下,交互式管理器已足够。也可以直接使用以下斜杠命令:
|
||
|
||
| 命令 | 说明 |
|
||
| --- | --- |
|
||
| `/plugins` | 打开交互式 plugin 管理器。 |
|
||
| `/plugins list` | 列出已安装 plugins。 |
|
||
| `/plugins install <path-or-url>` | 从本地目录(支持相对路径和 `~/`)、zip URL 或 GitHub 仓库 URL 安装。 |
|
||
| `/plugins marketplace [source]` | 浏览官方 marketplace;可选传入 marketplace JSON 的路径或 URL。 |
|
||
| `/plugins info <id>` | 查看 plugin 详情和 diagnostics;省略 `<id>` 时打开管理器。 |
|
||
| `/plugins <id>` | 查看指定 plugin 详情,等同于 `/plugins info <id>`。 |
|
||
| `/plugins enable <id>` | 启用 plugin;省略 `<id>` 时打开管理器。 |
|
||
| `/plugins disable <id>` | 禁用 plugin;省略 `<id>` 时打开管理器。 |
|
||
| `/plugins remove <id>` | 移除 plugin,需二次确认。 |
|
||
| `/plugins reload` | 重载 `installed.json` 和各 plugin manifest。 |
|
||
| `/plugins mcp enable <id> <server>` | 启用 plugin 声明的 MCP server。 |
|
||
| `/plugins mcp disable <id> <server>` | 禁用 plugin 声明的 MCP server。 |
|
||
|
||
斜杠命令的通用行为见 [斜杠命令](../reference/slash-commands.md)。
|
||
|
||
GitHub URL 支持四种形式。裸 URL `https://github.com/<owner>/<repo>` 会安装该仓库最新的 GitHub release;仓库没有 release 时回落到默认分支。`https://github.com/<owner>/<repo>/tree/<ref>` 用于安装指定分支、tag 或短 commit SHA。`https://github.com/<owner>/<repo>/releases/tag/<tag>` 和 `https://github.com/<owner>/<repo>/commit/<sha>` 用于钉死具体的 tag 或 commit。网络请求只走 `github.com` 重定向和 `codeload.github.com` 下载,**不会**调用 `api.github.com`。
|
||
|
||
Plugin 管理器会展示每个安装的来源以及一个信任徽章。`kimi-official` 表示 plugin zip 来自 `https://code.kimi.com/kimi-code/plugins/official/`;`curated` 表示 plugin zip 来自 `https://code.kimi.com/kimi-code/plugins/curated/`。`third-party` 表示其它所有情况,包括 GitHub 安装、本地目录、自定义 marketplace source 和其它 URL。
|
||
|
||
Kimi Code CLI 目前按用户安装 plugins,记录在 `$KIMI_CODE_HOME/plugins/` 下,对所有项目生效。暂不支持项目级、仓库级、管理员分发,以及带 `--scope` 的安装方式。
|
||
|
||
Plugin 变更只对新会话生效。安装、启用/禁用、移除、重载 plugin,或修改 MCP server 开关后,需要通过 `/new` 开启新会话;当前会话不会更新,新的 Skills、会话启动行为和 MCP servers 只会在新会话中加载。
|
||
|
||
本地安装会被拷贝到 `$KIMI_CODE_HOME/plugins/managed/<id>/`,Kimi Code CLI 始终从这份托管副本运行。安装后再编辑原始源目录不会生效,需要重新安装——`/plugins reload` 只会重读安装记录和 manifest,不会重读原始源。移除 plugin 只会删除其安装记录,托管副本和原始源文件仍保留在磁盘上。
|
||
|
||
## Plugin manifest
|
||
|
||
Plugin 是一个带 manifest 的目录或 zip 文件。Manifest 可以放在以下任一位置:
|
||
|
||
```text
|
||
<plugin_root>/kimi.plugin.json
|
||
<plugin_root>/.kimi-plugin/plugin.json
|
||
```
|
||
|
||
两个文件同时存在时,以 `kimi.plugin.json` 为准。Kimi Code CLI 不会读取根目录的 `plugin.json` 或 `.codex-plugin/plugin.json`。
|
||
|
||
示例:
|
||
|
||
```json
|
||
{
|
||
"name": "kimi-finance",
|
||
"version": "1.0.0",
|
||
"description": "Finance data and analysis workflows for Kimi Code CLI",
|
||
"skills": "./skills/",
|
||
"sessionStart": {
|
||
"skill": "using-finance"
|
||
},
|
||
"interface": {
|
||
"displayName": "Kimi Finance",
|
||
"shortDescription": "Market data and financial analysis workflows"
|
||
}
|
||
}
|
||
```
|
||
|
||
支持的字段:
|
||
|
||
| 字段 | 说明 |
|
||
| --- | --- |
|
||
| `name` | 必填,作为 plugin id。必须匹配 `[a-z0-9][a-z0-9_-]{0,63}`。 |
|
||
| `version`、`description`、`keywords`、`author`、`homepage`、`license` | 展示元数据。 |
|
||
| `interface` | 在 `/plugins` 中展示的字段,例如 `displayName`、`shortDescription`、`longDescription`、`developerName` 和 `websiteURL`。 |
|
||
| `skills` | 一个或多个 `./` 路径,必须位于 plugin 根目录内。如果省略,根目录的 `SKILL.md` 会被当作单个 Skill root。 |
|
||
| `sessionStart.skill` | 在新会话或恢复会话开始时,把指定 plugin Skill 加载到主 Agent。 |
|
||
| `skillInstructions` | 每次加载此 plugin 的 Skill 时,一并附带的额外说明。 |
|
||
| `mcpServers` | MCP server 声明。默认启用,可以从 `/plugins` 中禁用。 |
|
||
|
||
`tools`、`commands`、`hooks`、`apps`、`inject`、`configFile`、`config_file`、`bootstrap` 等不支持的运行时字段会显示为 diagnostics,并被忽略。
|
||
|
||
## Skills 与 session start
|
||
|
||
Plugin Skills 使用与普通 [Agent Skills](./skills.md) 相同的 `SKILL.md` 格式。常见目录结构如下:
|
||
|
||
```text
|
||
my-plugin/
|
||
kimi.plugin.json
|
||
skills/
|
||
using-my-plugin/
|
||
SKILL.md
|
||
another-workflow/
|
||
SKILL.md
|
||
```
|
||
|
||
`sessionStart.skill` 会在会话启动时,把一个 plugin Skill 加载到主 Agent 中。它适合放置初始化说明、工作流规则,或将其他工具中的术语映射到 Kimi Code CLI。它只注入文本,不执行代码。
|
||
|
||
无论 Skill 是通过 `sessionStart.skill`、`/skill:<name>` 加载,还是由模型自动调用,`skillInstructions` 都会随该 plugin 的 Skill 一起出现。
|
||
|
||
## Plugin 中的 MCP servers
|
||
|
||
当 plugin 需要真实工具能力时,例如读取外部服务数据或启动本地辅助进程,可以在 manifest 中声明 `mcpServers`。Plugin MCP servers 复用 [MCP](./mcp.md) 的 schema。
|
||
|
||
Stdio server:
|
||
|
||
```json
|
||
{
|
||
"mcpServers": {
|
||
"finance": {
|
||
"command": "uvx",
|
||
"args": ["kimi-finance-mcp"]
|
||
}
|
||
}
|
||
}
|
||
```
|
||
|
||
HTTP server:
|
||
|
||
```json
|
||
{
|
||
"mcpServers": {
|
||
"docs": {
|
||
"url": "https://example.com/mcp"
|
||
}
|
||
}
|
||
}
|
||
```
|
||
|
||
对于 stdio servers,`command` 可以是 `PATH` 上的命令,也可以是 plugin 根目录内以 `./` 开头的路径。如果设置了 `cwd`,它也必须以 `./` 开头并位于 plugin 根目录内;其他取值会被拒绝,该 server 会被忽略。Plugin MCP servers 会继承当前进程的环境变量;`env` 中的值会按字面量覆盖。
|
||
|
||
Plugin MCP servers 只会在新会话中启动。要禁用或重新启用某个 server,运行 `/plugins`,选中 plugin 后按 `M`。也可以使用快捷命令:
|
||
|
||
```sh
|
||
/plugins mcp disable kimi-finance finance
|
||
/new
|
||
|
||
/plugins mcp enable kimi-finance finance
|
||
/new
|
||
```
|
||
|
||
## 安全模型
|
||
|
||
Plugins 的加载范围有限:
|
||
|
||
- 安装和会话启动时,仅读取 plugin manifests 和 Markdown Skill 文件。
|
||
- 所有路径在解析符号链接后仍必须位于 plugin 根目录内。
|
||
- 命令型 plugin tools、hooks 和旧式工具运行时不会由 plugin loader 执行。
|
||
- 已启用 plugin 声明的 MCP servers 只会在新会话中启动,并且可以从 `/plugins` 中禁用。
|
||
- 损坏的 manifest 或不安全路径会显示在 `/plugins info <id>` 的 diagnostics 中,不会让无关会话崩溃。
|