loki-mode

环境要求

• Bun（推荐，最快启动）或 Node.js/npm 环境
• 可选：Docker（使用官方镜像方式安装时）
• 可选：Claude Code（安装 Loki 插件时使用）
• 安装和升级需要网络；`npx loki-mode tour` 试跑不需要网络

安装与启动步骤

1. 1先免安装试跑

   不安装、不需要 API Key、不联网也不会产生费用，直接打印一份真实构建的 Evidence Receipt。

   npx loki-mode tour

   复制

2. 2安装 loki-mode

   官方推荐用 Bun 全局安装，得到 loki CLI。

   bun install -g loki-mode

   复制

3. 3换用 npm 安装

   没有 Bun 也可以走 npm 安装，会自动回退到 bash 实现；随时可迁移。

   npm install -g loki-mode

   复制

4. 4或用 Homebrew

   Homebrew 安装会自动把 Bun 作为依赖装上。

   brew tap asklokesh/tap && brew install loki-mode

   复制

5. 5或拉取 Docker 镜像

   镜像里已预装 Bun 和 Claude CLI，适合容器化环境。

   docker pull asklokesh/loki-mode:latest

   复制

6. 6升级到最新版

   后续升级只需执行一条命令；也可用 `loki self-update --to bun` 从 npm 迁移到 Bun。

   loki self-update

   复制

7. 7生成配置文件模板

   生成一份起步用的配置，便于了解可填写的字段。

   loki config example

   复制

8. 8按配置启动

   把配置文件传给 loki start，格式由扩展名或内容自动识别。

   loki start --config ./loki.yaml

   复制

关键配置

如何确认成功

执行 `npx loki-mode tour` 能打印出带 Headline 和文件数、Diff sha256 的 Evidence Receipt，即说明工具可用。

常见问题

注意事项

• 不要把密钥直接写进配置文件，用 `${VAR}` 引用环境变量，加载器会在读取时展开；未设置的引用会跳过并给出警告。
• 命令行参数、环境变量、配置文件和默认值的优先级依次降低，排查问题时先看这一顺序。
• 安装方式可随时迁移，例如 npm 换 Bun 用 `loki self-update --to bun`。
• Docker 镜像已预装 Bun 和 Claude CLI，容器内可直接使用。