ktx

环境要求

• Node.js 与 npm（需支持全局安装 npm 包）
• 可访问 npm registry 的网络环境
• 用于存放 ktx 项目的本地目录（如 /home/user/analytics）
• 可选：已安装 Claude Code、Codex、Cursor、OpenCode 等智能体客户端

安装与启动步骤

1. 1全局安装 ktx

   通过 npm 全局安装 @kaelio/ktx，安装完成后终端即可直接使用 ktx 命令。

   npm install -g @kaelio/ktx

   复制

2. 2运行初始化向导

   执行 ktx setup，创建或恢复本地 ktx 项目，配置 provider 与连接，构建上下文并安装智能体集成。

   ktx setup

   复制

3. 3检查就绪状态

   运行 ktx status，查看项目、LLM、嵌入模型、数据库、上下文源和智能体集成是否都已就绪。

   ktx status

   复制

4. 4按提示启动 MCP

   若 status 输出 ktx mcp start --project-dir ...，必须在打开智能体客户端之前先运行它。

   ktx mcp start --project-dir /home/user/analytics

   复制

5. 5skill 方式安装

   已在用 Claude Code、Codex、Cursor、OpenCode 时，在项目目录让智能体用该命令以 ktx skill 完成安装配置。

   npx skills add Kaelio/ktx --skill ktx

   复制

如何确认成功

运行 ktx status，输出中 Project ready、LLM ready、Embeddings ready、Databases configured、Context sources configured、ktx context b

常见问题

注意事项

• 没有安装 Node.js 与 npm 时无法执行 npm install -g，请先准备好 Node 环境。
• ktx status 打印出的 ktx mcp start 命令必须在打开智能体客户端之前运行。
• README 未给出 Node 版本、端口、配置文件路径等细节，具体以官方文档 https://docs.kaelio.com/ktx 为准。