Kimi Code CLI 文档

简体中文

English

简体中文

English

Appearance

插件 ​

插件系统让你可以为 Kimi Code CLI 添加自定义工具，扩展 AI 的能力。与 MCP 服务器不同，插件是轻量级的本地工具包，适合封装项目特定的脚本和实用程序。

插件是什么 ​

一个插件就是一个包含 plugin.json 文件的目录。插件可以声明多个「工具」，每个工具是一个可执行命令（Python、TypeScript、Shell 脚本等），AI 可以调用这些工具来完成特定任务。

例如，你可以创建一个插件来：

  • 封装内部 API 的调用脚本
  • 提供项目特定的代码生成工具
  • 集成专有服务或数据库查询

插件与 Agent Skills 的区别：

  • Skills：通过 SKILL.md 提供知识性指导，AI 读取后遵循其中的规范
  • Plugins：通过 plugin.json 声明可执行工具，AI 可以直接调用工具获取结果

安装插件 ​

使用 kimi plugin 命令管理插件。

从本地目录安装

sh
kimi plugin install /path/to/my-plugin

从 ZIP 文件安装

sh
kimi plugin install my-plugin.zip

从 Git 仓库安装

sh
# 安装根目录的插件
kimi plugin install https://github.com/user/repo.git

# 安装子目录中的插件（多插件仓库）
kimi plugin install https://github.com/user/repo.git/plugins/my-plugin

# 指定分支（使用浏览器 URL 格式）
kimi plugin install https://github.com/user/repo/tree/develop/plugins/my-plugin

当 Git 仓库根目录没有 plugin.json 时，Kimi Code CLI 会检查根目录及其直接子目录，并列出可用的插件供你选择。

列出已安装插件

sh
kimi plugin list

查看插件详情

sh
kimi plugin info my-plugin

移除插件

sh
kimi plugin remove my-plugin

创建插件 ​

创建插件只需要三步：

  1. 创建一个目录
  2. 编写 plugin.json 文件
  3. 实现工具脚本

目录结构

my-plugin/
├── plugin.json       # 插件配置（必需）
├── config.json       # 插件配置（可选，用于凭证注入）
└── scripts/          # 工具脚本
    ├── greet.py
    └── calc.ts

plugin.json 格式

json
{
  "name": "my-plugin",
  "version": "1.0.0",
  "description": "My custom plugin for project X",
  "config_file": "config.json",
  "inject": {
    "api_key": "api_key",
    "endpoint": "base_url"
  },
  "tools": [
    {
      "name": "greet",
      "description": "Generate a greeting message",
      "command": ["python3", "scripts/greet.py"],
      "parameters": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Name to greet"
          }
        },
        "required": ["name"]
      }
    }
  ]
}

字段说明

字段说明是否必填
name插件名称，只能使用小写字母、数字和连字符是
version插件版本，语义化版本格式是
description插件描述否
config_file配置文件路径，用于凭证注入否
inject凭证注入映射，键为目标路径，值为源变量名否
tools工具列表否

工具字段说明

字段说明是否必填
name工具名称是
description工具描述是
command执行命令，字符串数组是
parametersJSON Schema 格式的参数定义否

凭证注入 ​

如果你的插件需要调用 LLM API，可以通过 inject 配置自动获取 Kimi Code CLI 的凭证配置。

inject 配置示例

json
{
  "config_file": "config.json",
  "inject": {
    "llm.api_key": "api_key",
    "llm.endpoint": "base_url"
  }
}

支持的注入变量

变量名说明
api_keyLLM 提供商的 API 密钥，支持 OAuth token 和静态 API key
base_urlLLM API 的基础 URL

config.json 模板

json
{
  "llm": {
    "api_key": "",
    "endpoint": ""
  }
}

安装时，Kimi Code CLI 会将当前配置的 API 密钥和 base URL 注入到指定的配置文件中。如果配置了 OAuth，会自动获取并注入有效的 token。之后在应用启动时，Kimi Code CLI 也会尝试将最新的凭证（如刷新后的 OAuth token）写入已安装插件的配置文件中。

提示

一般情况下，不需要为了更新凭证而重新安装插件：切换 LLM 提供商或重新授权后，重启 Kimi Code CLI 即可自动刷新配置文件中的凭证，插件工具在实际运行时也会通过环境变量获得当前有效的凭证。只有在修改了插件本身的配置结构（例如 config_file 或 inject 映射）时，才需要重新安装插件。

关于 inject 键名

inject 中的键名（如 llm.api_key）也会被用作环境变量名传递给插件工具子进程。由于这些名称包含点号，在某些运行环境中访问可能不便（例如 POSIX shell 中 $llm.api_key 是无效的）。你可以通过字典/映射方式访问：

  • Node.js: process.env["llm.api_key"]
  • Python: os.environ["llm.api_key"]

如果希望使用更友好的环境变量名，建议在插件中使用大写下划线格式（如 LLM_API_KEY），并相应调整配置文件结构。

工具脚本规范 ​

工具脚本通过标准输入接收参数，通过标准输出返回结果。

输入格式

脚本从 stdin 接收 JSON 对象：

json
{
  "name": "World"
}

输出格式

脚本向 stdout 输出的内容会作为字符串返回给 Agent。如果需要结构化输出，建议输出 JSON 文本：

json
{
  "content": "Hello, World!"
}

Python 示例

python
#!/usr/bin/env python3
import json
import sys

params = json.load(sys.stdin)
name = params.get("name", "Guest")

result = {"content": f"Hello, {name}!"}
print(json.dumps(result))

TypeScript 示例

typescript
#!/usr/bin/env tsx
import * as readline from "readline";

const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout,
  terminal: false,
});

let input = "";
rl.on("line", (line) => {
  input += line;
});

rl.on("close", () => {
  const params = JSON.parse(input);
  const name = params.name || "Guest";
  console.log(JSON.stringify({ content: `Hello, ${name}!` }));
});

完整示例 ​

json
{
  "name": "sample-plugin",
  "version": "1.0.0",
  "description": "Sample plugin demonstrating Skills + Tools",
  "tools": [
    {
      "name": "py_greet",
      "description": "Generate a greeting message (Python tool)",
      "command": ["python3", "scripts/greet.py"],
      "parameters": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Name to greet"
          },
          "lang": {
            "type": "string",
            "enum": ["en", "zh", "ja"],
            "description": "Language"
          }
        },
        "required": ["name"]
      }
    },
    {
      "name": "ts_calc",
      "description": "Evaluate a math expression (TypeScript tool)",
      "command": ["npx", "tsx", "scripts/calc.ts"],
      "parameters": {
        "type": "object",
        "properties": {
          "expression": {
            "type": "string",
            "description": "Math expression to evaluate"
          }
        },
        "required": ["expression"]
      }
    }
  ]
}

插件安装位置 ​

插件安装在 ~/.kimi/plugins/ 目录下。每个插件是一个独立的子目录，包含完整的 plugin.json 和脚本文件。

说明

插件与 MCP 服务器是互补的扩展机制：

  • MCP：适合需要持续运行的服务、复杂的工具编排、跨进程通信
  • 插件：适合简单的脚本封装、项目特定的工具、快速原型开发