AI写小说必备神器:InkOS完整安装配置教程

1. 环境要求

检查环境

node -v       # 应显示 v20.x.x 或更高npm -v        # 随 Node.js 附带git --version

安装 Node.js（如未安装）

macOS（推荐使用 nvm）：

# 安装 nvmcurl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bashsource ~/.zshrc   # 或 source ~/.bashrc# 安装 Node.js 20nvm install 20nvm use 20

Windows：

• 前往 https://nodejs.org 下载 LTS 版本安装包，按向导安装即可。

Linux（Ubuntu/Debian）：

curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -sudo apt-get install -y nodejs

2. 方式一：全局 npm 安装（推荐新手）

这是最简单的方式，适合直接使用而不需要修改源码。

# 全局安装 inkosnpm i -g @actalk/inkos# 验证安装inkos --version

安装成功后，inkos 命令即可在任意目录使用。跳至第4节继续配置。

3. 方式二：源码本地部署（推荐开发者）

1 克隆仓库

git clone https://github.com/Narcooo/inkos.gitcd inkos

2 安装 pnpm（如未安装）

npm install -g pnpmpnpm -v  # 验证安装

3 安装依赖

pnpm install

4 构建项目

pnpm build

5 将 CLI 链接到全局（可选）

# 链接后可以在任意目录使用 inkos 命令pnpm link --global

或者也可以在项目根目录通过 node 直接运行：

node packages/cli/dist/index.js --version

6 开发模式（实时监听修改）

pnpm dev

7 其他开发命令

pnpm test# 运行测试pnpm typecheck  # TypeScript 类型检查

4. 配置 .env 环境变量

1 在工作目录初始化配置

进入你想要存放小说项目的目录（任意位置），执行：

mkdir my-novels    # 创建工作目录cd my-novelsinkos init         # 初始化项目，自动生成 .env 模板

2 编辑 .env 文件

用文本编辑器打开 .env 文件：

# macOS / Linuxnano .env# 或code .env   # VSCode# Windowsnotepad .env

3 核心配置项说明

# ===== LLM 接口配置（必填）=====# API 基础地址（支持所有 OpenAI 兼容接口）LLM_BASE_URL=https://api.openai.com/v1# 例如使用 DeepSeek：# LLM_BASE_URL=https://api.deepseek.com/v1# 例如使用 Moonshot：# LLM_BASE_URL=https://api.moonshot.cn/v1# API 密钥（必填）LLM_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxx# 默认模型名称LLM_MODEL=gpt-4o# DeepSeek 示例：LLM_MODEL=deepseek-chat# Moonshot 示例：LLM_MODEL=moonshot-v1-32k# ===== 可选：各 Agent 独立模型配置 =====# 不同 Agent 可使用不同模型，不填则使用默认模型# 建筑师 Agent（规划章节结构）# ARCHITECT_MODEL=gpt-4o# 写手 Agent（生成正文）# WRITER_MODEL=gpt-4o# 审计 Agent（连续性检查）# AUDITOR_MODEL=gpt-4o-mini# 修订 Agent（修复问题）# REVISER_MODEL=gpt-4o# 雷达 Agent（扫描市场趋势，可选）# RADAR_MODEL=gpt-4o-mini# ===== 通知推送配置（可选）=====# Telegram# TELEGRAM_BOT_TOKEN=your_bot_token# TELEGRAM_CHAT_ID=your_chat_id# 飞书# FEISHU_WEBHOOK=https://open.feishu.cn/open-apis/bot/v2/hook/xxx# 企业微信# WECOM_WEBHOOK=https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxx

4 推荐的模型搭配

5. 初始化项目

# 诊断配置是否正确inkos doctor# 查看当前配置inkos config show

inkos doctor 会检测：

• Node.js 版本是否满足要求
• .env 文件是否存在
• API Key 是否已填写
• LLM 接口是否可连通

6. 创建第一本书

1 创建新书

inkos book create --title "吞天魔帝" --genre xuanhuan

支持的题材（--genre）：

创建时，建筑师 Agent 会自动生成：

• story_bible.md：世界观设定
• style_guide.md：文风指南
• 第一卷大纲

2 查看书籍列表

inkos book list

3 写第一章（完整管线）

# 自动完成：起草 → 审计 → 修订inkos write next 吞天魔帝# 加入创作指导inkos write next 吞天魔帝 --context "本章重点描写主角初入修炼界，展现世界观"# 连续写 5 章inkos write next 吞天魔帝 --count 5

4 查看项目状态

inkos status

5 审阅草稿

# 列出待审阅章节inkos review list 吞天魔帝# 通过某章inkos review approve 吞天魔帝 1# 拒绝某章（并添加修改意见）inkos review reject 吞天魔帝 1 --reason "第三节节奏太慢"# 批量通过全部inkos review approve-all 吞天魔帝

6 导出书稿

# 导出为 txt 或 md 格式inkos export 吞天魔帝

7. 写作命令速查

原子命令（JSON 输出，适合脚本）

inkos draft 吞天魔帝 --jsoninkos audit 吞天魔帝 31 --jsoninkos revise 吞天魔帝 31 --json

自然语言 Agent 模式

inkos agent "帮我写一本都市修仙，主角是个程序员"inkos agent "写下一章，重点写师徒矛盾"inkos agent "先扫描市场趋势，然后根据结果创建一本新书"

8. 可选：配置通知推送

在守护进程模式下，写完一章或审计不通过时，系统可向手机推送通知。

Telegram 推送

1. 在 Telegram 中找到 @BotFather，创建新 Bot，获取 BOT_TOKEN
2. 给你的 Bot 发一条消息，然后访问：

   https://api.telegram.org/bot<BOT_TOKEN>/getUpdates

   从返回结果中获取 chat_id

3. 填入 .env：

   TELEGRAM_BOT_TOKEN=your_bot_tokenTELEGRAM_CHAT_ID=your_chat_id

飞书推送

1. 在飞书群聊中添加「自定义机器人」
2. 复制 Webhook 地址，填入 .env：

   FEISHU_WEBHOOK=https://open.feishu.cn/open-apis/bot/v2/hook/xxx

企业微信推送

1. 在企业微信群中添加「群机器人」
2. 复制 Webhook 地址，填入 .env：

   WECOM_WEBHOOK=https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxx

9. 可选：守护进程模式

守护进程模式下，InkOS 会按计划自动循环写章，遇到无法自动修复的审计问题时暂停并推送通知。

# 启动守护进程（后台运行）inkos up# 停止守护进程inkos down# 查看运行状态inkos status

10. 常见问题排查

Q1：inkos: command not found

原因：全局安装未成功或 PATH 未配置。

# 确认 npm 全局目录npm root -g# 确认 inkos 是否安装npm list -g @actalk/inkos# 重新安装npm i -g @actalk/inkos

如使用 nvm，确保安装在当前激活的 Node.js 版本下。

Q2：inkos doctor 报告 API 连接失败

• 检查 .env 中 LLM_BASE_URL 末尾是否有 /v1
• 检查 LLM_API_KEY 是否正确，无多余空格
• 如使用国内代理服务，确认网络可访问对应接口
• 测试接口可用性：

  curl https://api.openai.com/v1/models \  -H "Authorization: Bearer $LLM_API_KEY"

Q3：源码构建报错 pnpm: command not found

npm install -g pnpm

Q4：章节审计循环无法通过

• 运行 inkos audit <书名> <章节号> --json 查看具体审计问题
• 手动运行 inkos revise <书名> <章节号> 尝试修订
• 若仍无法通过，可使用 inkos write rewrite <书名> <章节号> 回滚重写
• 尝试在写作时提供更明确的上下文：--context "..."

Q5：如何升级 InkOS

# npm 全局安装版本npm update -g @actalk/inkos# 源码版本git pullpnpm installpnpm build

项目文件结构参考

my-novels/├── .env                  # 环境变量配置├── books/│   └── 吞天魔帝/│       ├── story_bible.md      # 世界观设定│       ├── style_guide.md      # 文风指南│       ├── current_state.md    # 世界当前状态（真相文件）│       ├── particle_ledger.md  # 资源账本（真相文件）│       ├── pending_hooks.md    # 未闭合伏笔（真相文件）│       └── chapters/│           ├── ch001.md│           ├── ch002.md│           └── ...

相关链接

• 项目仓库：https://github.com/Narcooo/inkos
• npm 包：https://www.npmjs.com/package/@actalk/inkos
• 问题反馈：https://github.com/Narcooo/inkos/issues
• 开源协议：MIT