Skip to content

Kilo CLI 完整操作教程 ​

1. 安装 Kilo CLI ​

1.1 macOS / Linux 安装 ​

在终端中运行以下命令安装 Kilo CLI:

bash
npm install -g @kilocode/cli

验证安装成功:

bash
kilo --version

1.2 Windows 安装 ​

在 PowerShell(以管理员身份运行)中执行:

powershell
npm install -g @kilocode/cli

验证安装:

powershell
kilo --version

提示: 确保 PowerShell 已添加到 PATH 环境变量中。如未添加,需要:

  1. 打开"编辑系统环境变量"
  2. 点击"环境变量"
  3. 在系统变量中选择 Path → 编辑 → 新建
  4. 添加:C:\Windows\System32\WindowsPowerShell\v1.0\
  5. 点击确定并重启 PowerShell

2. TokenSwitch 中转 API 配置 ​

2.1 获取 API Key ​

  1. 使用浏览器访问:https://neolink.com/
  2. 使用管理员分配的账号登录
  3. 点击左侧菜单"API Key"
  4. 点击"创建API Key"按钮
  5. 保存生成的 API Key

2.2 配置方式 ​

Kilo CLI 支持三种配置 TokenSwitch API 的方式,优先级从高到低:

  1. 配置文件(推荐)- 支持 kilo.jsonc、kilo.json、opencode.jsonc 等格式
  2. 环境变量
  3. 启动参数

方式一:配置文件(推荐) ​

在项目根目录或全局配置目录创建配置文件:

项目级配置:

  • ./kilo.jsonc 或 ./kilo.json
  • ./.kilo/kilo.jsonc 或 ./.kilo/kilo.json
  • ./opencode.jsonc 或 ./opencode.json(兼容格式)
  • ./.kilo/opencode.jsonc 或 ./.kilo/opencode.json(兼容格式)

全局配置:

  • ~/.config/kilo/kilo.jsonc 或 ~/.config/kilo/kilo.json
  • ~/.config/kilo/opencode.jsonc 或 ~/.config/kilo/opencode.json(兼容格式)

在配置文件中添加以下内容(最小配置):

jsonc
{
  "$schema": "https://opencode.ai/config.json",
  "provider": {
    "tokenswitch": {
      "npm": "@ai-sdk/openai-compatible",
      "name": "TokenSwitch",
      "options": {
        "baseURL": {{apiUrl}},
        "apiKey": "你的API_KEY"
      },
      "models": {
        "cl-so-4.6": {
          "name": "Claude Sonnet 4.6"
        },
        "cl-ha-4.5-1001": {
          "name": "Claude Haiku 4.5"
        }
      }
    }
  }
}

完整示例配置(包含权限和超时设置):

jsonc
{
  "$schema": "https://opencode.ai/config.json",
  "default_model": "cl-so-4.6",
  "provider": {
    "tokenswitch": {
      "npm": "@ai-sdk/openai-compatible",
      "name": "TokenSwitch",
      "options": {
        "baseURL": {{apiUrl}},
        "apiKey": "你的API_KEY",
        "timeout": 300000
      },
      "models": {
        "cl-so-4.6": {
          "name": "Claude Sonnet 4.6"
        },
        "cl-ha-4.5-1001": {
          "name": "Claude Haiku 4.5"
        }
      }
    }
  },
  "permission": {
    "bash": "ask",
    "edit": "ask",
    "read": "allow"
  }
}

安全提示:如果将配置文件提交到版本控制系统,请确保 API Key 不被追踪。建议:

  • 使用环境变量存储敏感信息
  • 将配置文件(kilo.jsonc、opencode.jsonc 等)添加到 .gitignore
  • 或在配置文件中使用环境变量引用 API Key

方式二:环境变量 ​

macOS / Linux 配置 ​

对于 zsh(macOS 默认):

bash
echo 'export TOKENSWITCH_BASE_URL={{apiUrl}}' >> ~/.zshrc
echo 'export TOKENSWITCH_API_KEY="你的API_KEY"' >> ~/.zshrc
source ~/.zshrc

对于 bash:

bash
echo 'export TOKENSWITCH_BASE_URL={{apiUrl}}' >> ~/.bash_profile
echo 'export TOKENSWITCH_API_KEY="你的API_KEY"' >> ~/.bash_profile
source ~/.bash_profile

验证配置:

bash
echo $TOKENSWITCH_BASE_URL
echo $TOKENSWITCH_API_KEY
Windows 配置 ​

在 PowerShell 中运行以下命令设置用户级环境变量:

powershell
[System.Environment]::SetEnvironmentVariable("TOKENSWITCH_BASE_URL", "https://neolink.vnet.com/api/v1", [System.EnvironmentVariableTarget]::User)
[System.Environment]::SetEnvironmentVariable("TOKENSWITCH_API_KEY", "你的API_KEY", [System.EnvironmentVariableTarget]::User)

完成后重启 PowerShell 验证:

powershell
$env:TOKENSWITCH_BASE_URL
$env:TOKENSWITCH_API_KEY

方式三:启动参数 ​

启动 Kilo CLI 并指定 TokenSwitch API 配置(临时方案):

bash
kilo --base-url https://neolink.vnet.com/api/v1 --api-key 你的API_KEY

或使用环境变量:

bash
TOKENSWITCH_BASE_URL=https://neolink.vnet.com/api/v1 TOKENSWITCH_API_KEY=你的API_KEY kilo

2.3 配置文件优先级 ​

Kilo CLI 按以下顺序加载配置(后加载的会覆盖先加载的):

优先级配置位置说明
1(最低)/etc/kilo/ (Linux) 或 /Library/Application Support/kilo/ (macOS) 或 %ProgramData%\kilo\ (Windows)企业/管理员配置
2~/.config/kilo/kilo.jsonc全局用户配置
3环境变量 KILO_CONFIG指定的配置文件
4./kilo.jsonc 或 ./opencode.jsonc项目根目录配置
5./.kilo/kilo.jsonc 或 ./.kilo/opencode.jsonc项目 .kilo 目录配置(优先级最高)
6(最高)环境变量 KILO_CONFIG_CONTENT内联 JSON 配置

2.4 完整启动参数 ​

使用配置文件启动 Kilo CLI:

bash
cd /path/to/your/project
kilo

Kilo 会自动查找并加载配置文件。

3. 文件路径及加载注意事项 ​

3.1 项目工作目录 ​

Kilo CLI 需要在项目根目录运行。运行以下命令启动 Kilo:

bash
cd /path/to/your/project
kilo

3.2 CLAUDE.md 文件 ​

在项目根目录创建 CLAUDE.md 文件,用于存储项目规范和配置:

bash
# 项目根目录下创建 CLAUDE.md
cat > CLAUDE.md << 'EOF'
# 项目规范

## 代码规范
- 使用 TypeScript
- 测试框架:Vitest
- 缩进:2 空格
- Linter:ESLint

## 项目结构
- src/: 源代码
- tests/: 测试文件
- docs/: 文档

## 其他注意事项
- 提交前运行 `npm run lint` 和 `npm run test`
- Pull Request 需要通过所有测试
EOF

好处:

  • 不需要在每次对话中重复项目规范
  • 减少输入 Token 消耗
  • 确保 AI 理解项目的特定要求

3.3 文件加载路径 ​

明确指定文件路径 ​

在提示中明确引用项目文件:

bash
kilo "分析 src/auth/login.ts 的权限校验逻辑"

引用日志和文件内容 ​

bash
kilo "修复用户登录时的 500 错误,参考 logs/error.log 中的报错信息"

查看特定文件 ​

bash
# 让 Kilo 查看并解释代码
kilo "解释 config/database.ts 的数据库连接配置"

3.4 路径注意事项 ​

项目说明
工作目录必须在项目根目录运行 kilo
相对路径所有文件路径都相对于项目根目录
CLAUDE.md放在项目根目录,自动被加载
日志文件使用相对路径引用:logs/error.log
代码文件优先使用相对路径:src/services/user.ts

4. 常用内置指令说明 ​

4.1 基础命令 ​

在 Kilo CLI 交互界面中,可以使用斜杠命令:

命令说明
/clear清空当前会话,开始新的对话
/config查看和修改 Kilo 配置
/model切换 AI 模型
/help显示帮助信息
/exit退出 Kilo CLI

4.2 会话管理 - /clear ​

在完成一个任务后立即使用 /clear:

bash
# 完成修复 Bug 后
/clear

好处:

  • 清除过时的上下文
  • 减少不必要的 Token 消耗
  • 开始新的独立任务

4.3 模型切换 - /model ​

查看可用模型并切换:

bash
/model

选择适合任务的模型:

  • 简单任务:使用轻量级模型(节省成本)
  • 复杂分析:使用高级模型(精度更高)

4.4 配置管理 - /config ​

查看和调整配置参数:

bash
/config

常用配置项:

  • MAX_THINKING_TOKENS:控制模型思考预算
  • API_KEY:API 密钥
  • BASE_URL:API 端点地址

调整思考预算(简单任务):

bash
/config MAX_THINKING_TOKENS 1000

4.5 常见工作流 ​

代码探索 ​

bash
# 理解项目结构
kilo "这个项目的主要模块有哪些?目录结构如何?"

# 解释某个功能
kilo "解释 src/services/payment.ts 的支付流程实现"

# 查找相关代码
kilo "项目中哪些文件处理错误日志?"

Bug 修复 ​

bash
# 修复特定错误
kilo "修复用户登录时的 500 错误,参考 logs/error.log"

# 完成后清空上下文
/clear

# 开始下一个任务
kilo "实现用户注册功能"

代码生成 ​

bash
# 生成测试用例
kilo "为 auth.service.ts 编写单元测试并运行"

# 自动化重构
kilo "把项目中所有过时的 API 调用更新为 v2 版本,并运行 lint"

# 生成文档
kilo "为 src/api/ 目录下的所有 API 生成 OpenAPI 文档"

5. 使用技巧 ​

5.1 优化 Token 消耗 ​

创建 CLAUDE.md 规范文件

避免每次重复说明项目规范:

bash
# 一次性定义项目规范
cat > CLAUDE.md << 'EOF'
# 项目规范
- TypeScript 严格模式
- ESLint 检查
- Jest 测试框架
- 2 空格缩进
EOF

控制思考预算

对于简单任务,降低思考预算:

bash
/config MAX_THINKING_TOKENS 500

及时使用 /clear

bash
# 完成任务后立即清空
/clear

5.2 提高代码质量 ​

使用计划模式

在大规模改动前,让 Kilo 先制定计划:

bash
# 按 Tab 键进入计划模式
# 或在提示中明确要求计划
kilo "Plan: 重构 auth 模块的步骤"

验证修改

bash
# 让 Kilo 运行测试验证
kilo "修复 Bug 后请运行 npm test 验证所有测试通过"

5.3 最佳实践 ​

做法说明
✅ 创建 CLAUDE.md定义项目规范,减少 Token 消耗
✅ 及时 /clear完成任务后清空会话
✅ 明确指定文件使用相对路径引用具体文件
✅ 一次一个任务避免混杂多个需求
❌ 长会话避免在一个会话中聊太久
❌ 模糊描述避免不清楚的需求描述
❌ 忽视错误及时处理和验证修改

6. 故障排除 ​

6.1 环境变量未生效 ​

macOS/Linux:

bash
# 确认配置文件已更新
cat ~/.zshrc | grep TOKENSWITCH

# 重新加载配置
source ~/.zshrc

Windows:

powershell
# 重启 PowerShell 使变量生效
# 或检查环境变量
Get-ChildItem env:TOKENSWITCH_*

6.2 API 连接失败 ​

检查配置:

bash
# 验证 API URL
echo $TOKENSWITCH_BASE_URL

# 验证 API Key
echo $TOKENSWITCH_API_KEY

# 测试连接
kilo "hello"

确保:

  • API URL 正确:
  • API Key 有效且未过期
  • 网络连接正常
  • 如果配置文件方式,检查 kilo.jsonc 或 opencode.jsonc 中的 provider 配置

6.3 模型不可用 ​

切换到可用模型:

bash
/model
# 选择列表中的可用模型

7. 更多资源 ​