安装

KaaS 提供三种安装路径，选择适合你的方式：

路径	适用场景	前置条件
Docker	生产环境或一键部署	Docker
CLI	直接运行在主机上	Linux/macOS, amd64/arm64
Agent 模式	已在 Claude Code / Codex 中工作的用户	编码 Agent + Python (uv/pipx/pip)

所有路径都需要一个 OpenAI 兼容的 API Key（OpenAI、DeepSeek、Ollama、vLLM、Azure 等）。

---

方式 A: Docker（推荐）

1. 构建镜像

docker build -t kaas https://github.com/bybit-exchange/kaas.git

或者克隆后本地构建：

git clone https://github.com/bybit-exchange/kaas.git
cd kaas
docker build -t kaas .

2. 启动容器

docker run -d --name kaas \
  -p 8080:8080 \
  -v ./data:/app/data \
  -e LLM_API_KEY=sk-xxx \
  -e LLM_BASE_URL=https://api.openai.com/v1 \
  -e LLM_MODEL=gpt-4o-mini \
  kaas

参数说明：

参数	用途
-p 8080:8080	将容器 8080 端口映射到主机
-v ./data:/app/data	持久化 Wiki 数据和 SQLite 数据库
-e LLM_API_KEY	你的 OpenAI 兼容 API Key
-e LLM_BASE_URL	API 端点（默认：https://api.openai.com/v1）
-e LLM_MODEL	模型名称（默认：gpt-4o-mini）

默认值

LLM_BASE_URL 默认为 https://api.openai.com/v1，LLM_MODEL 默认为 gpt-4o-mini。只有使用非 OpenAI 供应商时才需要显式设置。

3. 启用 MCP（可选）

让 Claude Code 或其他 MCP 客户端远程查询知识库：

docker run -d --name kaas \
  -p 8080:8080 \
  -v ./data:/app/data \
  -e LLM_API_KEY=sk-xxx \
  -e LLM_BASE_URL=https://api.openai.com/v1 \
  -e LLM_MODEL=gpt-4o-mini \
  -e KAAS_MCP_ENABLED=true \
  -e KAAS_MCP_TOKEN=your-secret-token \
  kaas

MCP 端点：http://<host>:8080/mcp
鉴权方式：Bearer your-secret-token

完整环境变量参考

环境变量	对应配置项	默认值
LLM_API_KEY	[llm] api_key	（必填）
LLM_BASE_URL	[llm] base_url	https://api.openai.com/v1
LLM_MODEL	[llm] model	gpt-4o-mini
LLM_SUMMARIZE_MODEL	[llm] summarize_model	同 LLM_MODEL
KAAS_MCP_ENABLED	[ai.mcp] enabled	false
KAAS_MCP_TOKEN	[ai.mcp] token	（空 = 无鉴权）
KAAS_WEB_DIR	[server] web_dir	/app/web/dist

---

方式 B: CLI 安装

1. 安装二进制文件

curl -fsSL https://raw.githubusercontent.com/bybit-exchange/kaas/main/install.sh | sh

支持平台：Linux/macOS，amd64/arm64。

脚本会将 kaas 二进制安装到 ~/.local/bin/kaas，数据存储于 ~/.local/share/kaas。

2. 设置环境变量

export LLM_API_KEY="sk-xxx"                       # 必填 — 你的 API Key
export LLM_BASE_URL="https://api.openai.com/v1"   # 可选 — 默认为 OpenAI
export LLM_MODEL="gpt-4o-mini"                    # 可选 — 默认为 gpt-4o-mini

建议将以上变量添加到 shell 配置文件（~/.bashrc、~/.zshrc）以持久化。

3. 启动服务

kaas serve

服务默认监听 http://localhost:8080。

卸载

rm -rf ~/.local/share/kaas ~/.local/bin/kaas

---

方式 C: Agent 模式（无需 Docker）

如果你已经在编码 Agent（Claude Code、Codex、openclaw 等）中工作，可以跳过 Docker。将以下提示词复制粘贴到你的 Agent 中：

Set up KaaS to build a queryable knowledge base from my files.
Fetch https://raw.githubusercontent.com/bybit-exchange/kaas/main/docs/agent-quickstart.md
and follow it exactly.

Agent 将自动执行以下步骤：

1. 安装 kb-ai — 依次尝试 uv tool install、pipx、pip：

   uv tool install "git+https://github.com/bybit-exchange/kaas.git#subdirectory=py"

2. 询问 LLM 凭证 — 你提供 API Key（以及可选的 base URL / model）。
3. 询问要蒸馏的内容来源 — 当前目录、其他路径、URL 或粘贴的文本。
4. 执行 kb-ai distill — 将你的内容编译为 .kaas/ Wiki。
5. 配置 MCP — 让后续 Agent 会话可以查询 Wiki：

   claude mcp add kaas -- env KAAS_KB_DIR=$(pwd)/.kaas LLM_API_KEY=$LLM_API_KEY kb-ai mcp

配置完成后，开启新的 Agent 会话即可直接提问 — 回答来自编译后的 Wiki，通过 ask 工具检索。

---

验证安装

无论选择哪种安装方式（Docker 或 CLI），都可以通过以下方式验证 KaaS 是否正常运行：

Web 界面

在浏览器中打开：

http://localhost:8080

你应该能看到 KaaS 仪表盘。

健康检查

curl http://localhost:8080/healthz

正常运行的实例会返回 HTTP 200。

---

下一步

• 配置 — 自定义 LLM 供应商、MCP 设置和存储选项
• 创建第一个知识库 — 提交内容并构建结构化 Wiki