Kode

终端中的 AI 编程伙伴

English · 贡献指南 · 文档 · 发布页

---

理解代码库 · 编辑文件 · 执行命令 · 编排工作流

目录

• 核心亮点
• 安装
• 快速开始
• 多模型协同
• Agents 与子代理
• 技能与插件
• MCP 扩展
• 权限与安全
• 配置
• 开发
• 许可证

核心亮点

安装

npm install -g @shareai-lab/kode

# 国内镜像
npm install -g @shareai-lab/kode --registry=https://registry.npmmirror.com

# 开发版（最新特性）
npm install -g @shareai-lab/kode@dev

安装后可用以下任一命令：

快速开始

交互模式

kode

单次模式

kode -p "解释这个函数" path/to/file.js

ACP 模式（Agent Client Protocol）

kode-acp          # stdio JSON-RPC，供 Toad/Zed 等客户端接入

快捷键

斜杠命令

/model          更改 AI 模型设置
/config         打开配置面板
/agents         管理子代理
/plugin         管理技能与插件
/output-style   切换输出风格
/cost           查看 Token 用量与费用
/clear          清除对话历史
/help           显示所有命令

多模型协同

与单模型工具不同，Kode 支持真正的多模型编排 — 为不同任务分配最合适的模型。

架构

┌─────────────────────────────────────────────────┐
│                  ModelManager                     │
├──────────┬──────────┬───────────┬───────────────┤
│   main   │   task   │  compact  │     quick     │
│  (主模型) │ (子代理) │  (压缩)   │   (轻量操作)  │
└──────────┴──────────┴───────────┴───────────────┘
         │                │                │
    主 Agent         SubAgents        专家咨询

模型指针 — 通过 /model 为不同角色配置默认模型：

可分享的配置（YAML）

kode models export --output kode-models.yaml   # 导出（不含明文密钥）
kode models import kode-models.yaml            # 导入（合并）
kode models import --replace kode-models.yaml  # 导入（替换）
kode models list                               # 列出配置

工作流示例

# 架构设计 — 使用推理模型
"用 o3 设计消息队列系统架构"

# 代码实现 — 使用编码模型
"用 Qwen Coder 作为子代理并行重构这三个模块"

# 专家咨询 — 请教专业模型
"问问 Claude Opus 4.1 这个内存泄漏怎么解决"

# 模型切换 — Option+M 或内联指定
"切换到 Kimi k2 进行代码审查"

核心能力对比

Agents 与子代理

Agents 是可复用的任务委派模版。

# 管理
/agents                          # 交互式 UI
kode agents validate             # 校验模版

# 运行
@run-agent-reviewer ...          # @ 提及方式
Task(subagent_type: "reviewer")  # 工具调用方式

Agent 文件（.kode/agents/reviewer.md）：

---
name: reviewer
description: "Review diffs for correctness, security, and simplicity"
tools: ["Read", "Grep"]
model: inherit
---

更严格一些：指出 bug / 风险点，优先推荐小而聚焦的修改。

加载来源：.kode/agents（项目）→ ~/.kode/agents（用户）→ 插件 → --agents 参数。

model 字段支持：inherit、指针名（main|task|compact|quick）、profile 名称、provider:modelName。

技能与插件

从 Marketplace 安装

kode plugin marketplace add owner/repo
kode plugin install document-skills@anthropic-agent-skills --scope user

使用技能

作为斜杠命令运行（/pdf、/xlsx），或让 Kode 自动调用。

创建技能

创建 .kode/skills/<name>/SKILL.md：

---
name: my-skill
description: 描述这个技能做什么、何时使用。
allowed-tools: Read Bash(git:*) Bash(jq:*)
---

# 技能说明

详见 docs/skills.md。

MCP 扩展

通过 Model Context Protocol 接入外部工具服务器。

kode mcp add              # 添加服务器
kode mcp list             # 查看已连接服务器
kode mcp remove <name>    # 移除服务器

配置文件（项目根目录 .mcp.json）：

{
  "my-server": { "type": "sse", "url": "http://127.0.0.1:3333/sse" }
}

权限与安全

系统沙箱（Linux）

启用 --safe 或 KODE_SYSTEM_SANDBOX=1 后，Bash 命令在 bwrap 沙箱中运行（默认禁用网络）。

网络与隐私

• 默认不发送遥测数据
• 仅在以下场景产生网络请求：模型 API 调用、Web 工具、插件下载、可选更新检查

配置

AGENTS.md 支持

Kode 从仓库根目录到 CWD 逐层发现指令文件：

• 优先 AGENTS.override.md > AGENTS.md（每层最多一个）
• 按 root → leaf 拼接（上限 32 KiB，可通过 KODE_PROJECT_DOC_MAX_BYTES 覆盖）
• 兼容 legacy CLAUDE.md / .claude/ 格式

Docker

git clone https://github.com/shareAI-lab/Kode.git && cd Kode
docker build --no-cache -t kode .

# 在项目目录中运行
cd your-project
docker run -it --rm \
  -v $(pwd):/workspace \
  -v ~/.kode:/root/.kode \
  -v ~/.kode.json:/root/.kode.json \
  -w /workspace \
  kode

开发

开发环境需要 Bun。

# 初始化
git clone https://github.com/shareAI-lab/kode.git && cd kode
bun install

# 开发 / 构建 / 测试
bun run dev
bun run build
bun test

许可证

Apache 2.0 — 自由用于个人、商业和企业项目。

致谢

• 部分代码源自 @dnakov 的 anonkode
• UI 灵感来自 gemini-cli
• 系统设计借鉴了上游 agent CLI 工具