Преглед изворни кода

docs: rewrite README for v0.2.0

Add three interaction modes (full pipeline, atomic commands, agent mode).
Update command reference to 15 commands. Document pluggable radar,
external agent integration, --json/--context flags.
majx_mac пре 8 месеци
родитељ
комит
a3d9bf48c2
1 измењених фајлова са 71 додато и 25 уклоњено
  1. 71 25
      README.md

+ 71 - 25
README.md

@@ -43,7 +43,7 @@ InkOS 为每一章运行多智能体管线:
 
 
 | 智能体 | 职责 |
 | 智能体 | 职责 |
 |--------|------|
 |--------|------|
-| **雷达 Radar** | 扫描平台趋势和读者偏好,指导故事方向 |
+| **雷达 Radar** | 扫描平台趋势和读者偏好,指导故事方向(可插拔,可跳过) |
 | **建筑师 Architect** | 规划章节结构:大纲、场景节拍、节奏控制 |
 | **建筑师 Architect** | 规划章节结构:大纲、场景节拍、节奏控制 |
 | **写手 Writer** | 根据大纲 + 当前世界状态生成正文 |
 | **写手 Writer** | 根据大纲 + 当前世界状态生成正文 |
 | **连续性审计员 Auditor** | 对照三大真相文件验证草稿 |
 | **连续性审计员 Auditor** | 对照三大真相文件验证草稿 |
@@ -80,6 +80,37 @@ InkOS 为每一章运行多智能体管线:
 
 
 每本书还有自己的 `style_guide.md`(文风指南)和 `story_bible.md`(世界观设定),由建筑师 agent 在创建书籍时生成。
 每本书还有自己的 `style_guide.md`(文风指南)和 `story_bible.md`(世界观设定),由建筑师 agent 在创建书籍时生成。
 
 
+## 三种使用模式
+
+InkOS 提供三种交互方式,底层共享同一组原子操作:
+
+### 1. 完整管线(一键式)
+
+```bash
+inkos write next 吞天魔帝          # 写草稿 → 审计 → 自动修订,一步到位
+inkos write next 吞天魔帝 --count 5 # 连续写 5 章
+```
+
+### 2. 原子命令(可组合,适合外部 Agent 调用)
+
+```bash
+inkos draft 吞天魔帝 --context "本章重点写师徒矛盾" --json
+inkos audit 吞天魔帝 31 --json
+inkos revise 吞天魔帝 31 --json
+```
+
+每个命令独立执行单一操作,`--json` 输出结构化数据。可被 OpenClaw 等自主智能体通过 `exec` 调用,也可用于脚本编排。
+
+### 3. 自然语言 Agent 模式(LLM 自主编排)
+
+```bash
+inkos agent "帮我写一本都市修仙,主角是个程序员"
+inkos agent "写下一章,重点写师徒矛盾"
+inkos agent "先扫描市场趋势,然后根据结果创建一本新书"
+```
+
+内置 9 个工具(write_draft、audit_chapter、revise_chapter、scan_market、create_book、get_book_status、read_truth_files、list_books、write_full_pipeline),LLM 通过 tool-use 自主决定调用顺序。
+
 ## 快速开始
 ## 快速开始
 
 
 ### 安装
 ### 安装
@@ -98,13 +129,12 @@ inkos init              # 初始化项目,生成 .env 模板
 ### 使用
 ### 使用
 
 
 ```bash
 ```bash
-inkos book create       # 创建新书(交互式,生成世界观+卷纲+文风指南)
-inkos write next        # 写下一章(完整五 agent 管线)
-inkos write rewrite <n> # 重写第 N 章(恢复状态快照后重新生成)
-inkos status            # 查看状态(章数、字数、伏笔、账本)
-inkos review            # 审阅草稿
-inkos export <book-id>  # 导出全书
-inkos up                # 守护进程模式,按计划自动写
+inkos book create --title "吞天魔帝" --genre xuanhuan  # 创建新书
+inkos write next 吞天魔帝      # 写下一章(完整管线)
+inkos status                   # 查看状态
+inkos review list 吞天魔帝     # 审阅草稿
+inkos export 吞天魔帝          # 导出全书
+inkos up                       # 守护进程模式
 ```
 ```
 
 
 <p align="center">
 <p align="center">
@@ -116,18 +146,24 @@ inkos up                # 守护进程模式,按计划自动写
 | 命令 | 说明 |
 | 命令 | 说明 |
 |------|------|
 |------|------|
 | `inkos init` | 初始化项目 |
 | `inkos init` | 初始化项目 |
-| `inkos book create` | 创建新书 |
-| `inkos write next` | 智能体管线写下一章 |
-| `inkos write rewrite <n>` | 重写第 N 章(恢复状态快照) |
-| `inkos review` | 审阅并通过/拒绝草稿 |
-| `inkos review approve-all <id>` | 批量通过所有待审章节 |
+| `inkos book create` | 创建新书(生成世界观 + 卷纲 + 文风指南) |
+| `inkos book list` | 列出所有书籍 |
+| `inkos write next <id>` | 完整管线写下一章 |
+| `inkos write rewrite <id> <n>` | 重写第 N 章(恢复状态快照) |
+| `inkos draft <id>` | 只写草稿(不审不改) |
+| `inkos audit <id> [n]` | 审计指定章节 |
+| `inkos revise <id> [n]` | 修订指定章节 |
+| `inkos agent <instruction>` | 自然语言 Agent 模式 |
+| `inkos review list/approve/reject` | 审阅草稿 |
+| `inkos review approve-all <id>` | 批量通过 |
 | `inkos status` | 项目状态 |
 | `inkos status` | 项目状态 |
 | `inkos export <id>` | 导出书籍为 txt/md |
 | `inkos export <id>` | 导出书籍为 txt/md |
-| `inkos radar` | 扫描平台趋势 |
-| `inkos config` | 查看/更新配置 |
+| `inkos radar scan` | 扫描平台趋势 |
+| `inkos config set/show` | 查看/更新配置 |
 | `inkos doctor` | 诊断配置问题 |
 | `inkos doctor` | 诊断配置问题 |
-| `inkos up` | 启动守护进程模式 |
-| `inkos down` | 停止守护进程 |
+| `inkos up / down` | 启动/停止守护进程 |
+
+所有命令支持 `--json` 输出结构化数据,`draft`/`write next`/`book create` 支持 `--context` 传入创作指导。
 
 
 ## 实测数据
 ## 实测数据
 
 
@@ -151,7 +187,7 @@ inkos up                # 守护进程模式,按计划自动写
 
 
 ### 状态快照 + 章节重写
 ### 状态快照 + 章节重写
 
 
-每章自动创建状态快照。使用 `inkos write rewrite <n>` 可以回滚并重新生成任意章节 — 世界状态、资源账本、伏笔钩子全部恢复到该章写入前的状态。
+每章自动创建状态快照。使用 `inkos write rewrite <id> <n>` 可以回滚并重新生成任意章节 — 世界状态、资源账本、伏笔钩子全部恢复到该章写入前的状态。
 
 
 ### 写入锁
 ### 写入锁
 
 
@@ -161,6 +197,10 @@ inkos up                # 守护进程模式,按计划自动写
 
 
 写手 agent 在动笔前必须输出自检表(上下文范围、当前资源、待回收伏笔、冲突概述、风险扫描),写完后输出结算表(资源变动、伏笔变动)。审计员对照结算表和正文内容做交叉验证。
 写手 agent 在动笔前必须输出自检表(上下文范围、当前资源、待回收伏笔、冲突概述、风险扫描),写完后输出结算表(资源变动、伏笔变动)。审计员对照结算表和正文内容做交叉验证。
 
 
+### 可插拔雷达
+
+雷达数据源通过 `RadarSource` 接口实现可插拔。内置番茄小说和起点中文网两个数据源,也可以传入自定义数据源或直接跳过雷达。用户自己提供题材时,agent 模式会自动跳过市场扫描。
+
 ### 守护进程模式
 ### 守护进程模式
 
 
 `inkos up` 启动自主循环,按计划写章。管线对非关键问题全自动运行,当审计员标记无法自动修复的问题时暂停等待人工审核。
 `inkos up` 启动自主循环,按计划写章。管线对非关键问题全自动运行,当审计员标记无法自动修复的问题时暂停等待人工审核。
@@ -169,6 +209,10 @@ inkos up                # 守护进程模式,按计划自动写
 
 
 支持 Telegram、飞书、企业微信。守护进程模式下,写完一章或审计不通过都会推通知到手机。
 支持 Telegram、飞书、企业微信。守护进程模式下,写完一章或审计不通过都会推通知到手机。
 
 
+### 外部 Agent 集成
+
+原子命令 + `--json` 输出让 InkOS 可以被 OpenClaw 等自主智能体调用。OpenClaw 通过 `exec` 工具执行 `inkos draft`/`audit`/`revise`,读取 JSON 结果决定下一步操作。
+
 ## 项目结构
 ## 项目结构
 
 
 ```
 ```
@@ -176,15 +220,13 @@ inkos/
 ├── packages/
 ├── packages/
 │   ├── core/              # 智能体运行时、管线、状态管理
 │   ├── core/              # 智能体运行时、管线、状态管理
 │   │   ├── agents/        # architect, writer, continuity, reviser, radar
 │   │   ├── agents/        # architect, writer, continuity, reviser, radar
-│   │   ├── pipeline/      # runner (写→审→改), scheduler (守护进程)
+│   │   ├── pipeline/      # runner (原子操作 + 完整管线), agent (tool-use 编排), scheduler
 │   │   ├── state/         # 基于文件的状态管理器
 │   │   ├── state/         # 基于文件的状态管理器
 │   │   ├── llm/           # OpenAI 兼容接口 (流式)
 │   │   ├── llm/           # OpenAI 兼容接口 (流式)
 │   │   ├── notify/        # Telegram, 飞书, 企业微信
 │   │   ├── notify/        # Telegram, 飞书, 企业微信
-│   │   ├── models/        # Zod schema 校验
-│   │   └── prompts/       # 提示词模板
-│   └── cli/               # Commander.js 命令行
-│       └── commands/      # init, book, write, review, status, export 等
-├── templates/             # 项目脚手架模板
+│   │   └── models/        # Zod schema 校验
+│   └── cli/               # Commander.js 命令行 (15 条命令)
+│       └── commands/      # init, book, write, draft, audit, revise, agent, review, status, export...
 └── (规划中) studio/        # 网页审阅编辑界面
 └── (规划中) studio/        # 网页审阅编辑界面
 ```
 ```
 
 
@@ -195,10 +237,14 @@ TypeScript 单仓库,pnpm workspaces 管理。
 - [x] 完整智能体管线(雷达 → 建筑师 → 写手 → 审计 → 修订)
 - [x] 完整智能体管线(雷达 → 建筑师 → 写手 → 审计 → 修订)
 - [x] 三大真相文件 + 连续性审计
 - [x] 三大真相文件 + 连续性审计
 - [x] 内置创作规则体系
 - [x] 内置创作规则体系
-- [x] CLI 全套命令
+- [x] CLI 全套命令(15 条)
 - [x] 状态快照 + 章节重写
 - [x] 状态快照 + 章节重写
 - [x] 守护进程模式
 - [x] 守护进程模式
 - [x] 通知推送(Telegram / 飞书 / 企微)
 - [x] 通知推送(Telegram / 飞书 / 企微)
+- [x] 原子命令 + JSON 输出(draft / audit / revise)
+- [x] 自然语言 Agent 模式(tool-use 编排)
+- [x] 可插拔雷达(RadarSource 接口)
+- [x] 外部 Agent 集成(OpenClaw 等)
 - [ ] `packages/studio` Web UI 审阅编辑界面
 - [ ] `packages/studio` Web UI 审阅编辑界面
 - [ ] 多模型路由(不同 agent 用不同模型)
 - [ ] 多模型路由(不同 agent 用不同模型)
 - [ ] 自定义 agent 插件系统
 - [ ] 自定义 agent 插件系统