inkos

环境要求

• Node.js 22 或更高版本
• npm（用于全局安装 @actalk/inkos）
• 一个大模型服务的 API Key（Google Gemini、Moonshot、MiniMax、智谱、百炼等）
• 可选：兼容 Agent（如 Claude Code、OpenClaw）用于 Skill 调用

安装与启动步骤

1. 1确认 Node 环境

   README 要求 Node.js 22 或更高版本，版本过低需先升级 Node 再安装 InkOS。

2. 2全局安装 InkOS

   通过 npm 全局安装 @actalk/inkos，安装后即可使用 inkos 命令行。

   npm i -g @actalk/inkos

   复制

3. 3初始化并启动 Studio

   创建书籍项目目录并进入，执行 inkos 打开 Studio 网页工作台。

   inkos init my-novel
   cd my-novel
   inkos

   复制

4. 4在 Studio 配置模型

   进入「模型配置」：选服务商、粘贴 API Key、测试连接、选模型并保存，再回到书籍页面写作。

5. 5配置 CLI 环境变量

   终端批处理、服务器、CI、Docker 等场景用 set-global 配置，或手写 .env 文件。

   inkos config set-global \
     --provider custom \
     --base-url https://api.moonshot.cn/v1 \
     --api-key sk-xxxxxxxx \
     --model kimi-k2.5

   复制

6. 6排查配置问题

   doctor 会显示当前生效的配置模式、service/model/API Key 来源，并尝试 API 连通性。

   inkos doctor

   复制

7. 7OpenClaw 调用（可选）

   可安装为 OpenClaw Skill 供兼容 Agent 调用；优先走共享交互入口 interact。

   clawhub install inkos
   inkos interact --json --message "继续当前书，但把节奏再收紧一点"

   复制

关键配置

如何确认成功

执行 inkos 可打开 Studio，在「模型配置」中测试连接通过；执行 inkos doctor 能看到生效配置模式与 API 连通性结果。

常见问题

注意事项

• API Key 存放在项目内的 .inkos/secrets.json，不会写进 inkos.json。
• Studio 用可视化服务配置，CLI / daemon / 部署环境支持 env 覆盖，两条路径互不污染。
• 使用 OpenClaw 时优先调用 inkos interact 入口，执行结果以工具结果和落盘文件为准，不从模型口头声明推断完成。
• 项目采用 AGPL-3.0 许可，商用或二次分发前请确认许可要求。