Home
Softono

Craft Companion

Open source MIT JavaScript
34
Stars
12
Forks
1
Issues
0
Watchers
5 months
Last Commit

 About Craft Companion

AI协作小说创作框架 - 结构化知识库 + 双入口初始化 + 5阶段工作流

Platforms

Web Self-hosted

Languages

JavaScript

Links

Need Help Installing Craft Companion?

We provide expert installation service for this software. Our team will install, configure, and secure Craft Companion on your server. plans start at just $30.

Craft Companion

View on GitHub

Craft Companion

让 AI 真正理解你的小说,而不是每章都重新猜。

AI 协作小说创作框架

结构化知识库 ✦ 双入口初始化 ✦ 5 阶段工作流

Version License Local First Dual Entry Workflow


最新更新(v1.2.0)

  • 统一 AI 入口:新增 AI入口_统一指令.md
  • 旧项目一键升级:craft-companion bootstrap-entry
  • 一键健康检查:craft-companion doctor
  • 双层质量保障:执行层自查 + 评估层复核
  • 连接异常排查:覆盖 tls: bad record MAC

查看完整发布说明:

  • docs/releases/v1.2.0.md

先看这里(最短路径)

如果你只想最快跑通,不想被文档绕晕,直接做这 4 步:

git clone https://github.com/qcx1919788736-collab/craft-companion.git
cd craft-companion
node tools/init.js
# 进入你刚创建的项目目录后:
craft-companion doctor

然后给 AI 发第一句:

请先读取 CLAUDE.md、START_HERE.md、AI入口_统一指令.md,然后带我完成第一步,不要提前写正文。

选择你的起点

从零开始写新小说

适合:还没有正文,想和 AI 一起搭建作品。

你会得到的体验:

  • 创建项目
  • AI 读取 START_HERE.md
  • AI 参考 提示模板/从零开始/ 的步骤模板引导你完成初始化
  • 再进入正式创作

导入已有小说

适合:已经写了几章、几十章,想迁移到 Craft Companion。

你会得到的体验:

  • 创建项目
  • AI 读取 START_HERE.md
  • AI 参考 提示模板/导入已有小说/ 的步骤模板引导你完成导入
  • 再进入正式创作

一句话理解

  • 没有正文 → 走 从零开始
  • 已有正文 → 走 导入已有小说

工作方式

flowchart LR
  U[用户请求] --> R{入口分流}
  R --> I[初始化/导入]
  I --> KB[知识库就绪]
  KB --> W[执行层 Writer\n章纲→初稿→自查]
  W --> E[评估层 Evaluator\nconfirmed/disputed/dismissed]
  E --> A[仲裁层 Arbiter\n裁决 disputed + 修订]
  A --> F[终版确认]
  F --> CP[(检查点 + 知识库更新)]

  classDef layer fill:#f6f8fa,stroke:#57606a,stroke-width:1px,color:#24292f;
  classDef gate fill:#fff8c5,stroke:#9a6700,stroke-width:1px,color:#3d2f00;
  class W,E,A layer;
  class R gate;

快速开始

1. 获取项目

git clone https://github.com/qcx1919788736-collab/craft-companion.git
cd craft-companion

2. 创建项目

node tools/init.js

创建完成后会生成:

  • 项目目录
  • CLAUDE.md
  • 基础知识库目录
  • START_HERE.md(告诉你下一步去哪)
  • 提示模板/(可直接在项目目录里使用)
  • docs/(项目内说明文档)
  • tools/(项目内可执行脚本)

3. 按你的模式继续

如果你选了“从零开始”

AI 会读取 START_HERE.md,并参考以下步骤模板来引导你完成初始化:

  • 提示模板/从零开始/01-定义核心概念.md
  • 提示模板/从零开始/02-构建主角.md
  • 提示模板/从零开始/03-设计故事结构.md
  • 提示模板/从零开始/04-建立文风.md
  • 提示模板/从零开始/05-准备开始创作.md

如果你选了“导入已有小说”

AI 会读取 START_HERE.md,并参考以下步骤模板来引导你完成导入:

  • 提示模板/导入已有小说/01-提取人物信息.md
  • 提示模板/导入已有小说/02-提取世界观设定.md
  • 提示模板/导入已有小说/03-构建时间线.md
  • 提示模板/导入已有小说/04-分析文风特征.md
  • 提示模板/导入已有小说/05-识别伏笔线索.md

这些模板主要是给 AI 参考的流程材料,不是要求用户手动逐个导入的操作说明。


5 阶段工作流

  1. 章纲:先生成章节方向或方案
  2. 初稿:写出正文初稿
  3. 自查:执行层自查 + 评估层复核
  4. 修订:根据反馈修改
  5. 终版确认:确认最终版本并更新知识库
flowchart LR
  A[1 章纲] --> G1{选定章纲?}
  G1 --> B[2 初稿]
  B --> C[3 自查\n执行层+评估层]
  C --> G2{有 disputed?}
  G2 -->|是| H[仲裁后修订]
  G2 -->|否| D[4 修订]
  H --> E[5 终版确认]
  D --> E
  E --> F[下一章]

  classDef gate fill:#fff8c5,stroke:#9a6700,stroke-width:1px,color:#3d2f00;
  class G1,G2 gate;

这套工作流的目标不是“让 AI 一把写完”,而是让 AI 在稳定约束下持续协作。


常用命令

# 创建新项目
node tools/init.js

# 导入已有作品的提示模板辅助
node tools/import-cli.js

# CLI 功能(按当前仓库实际情况使用)
craft-companion --help

# 给已有项目补齐统一入口(不动正文)
craft-companion bootstrap-entry

# 健康检查(入口/模板/接力/检查点)
craft-companion doctor

bootstrap-entry 会补齐入口与基础骨架(CLAUDE.md提示模板/docs/、核心上下文基础文件),不会改你的正文章节文件。


推荐使用方式

方式 A(首推):Codex / Claude Code

这是当前最推荐的协作方式,原因是:

  • 更容易发挥多 Agent 协作能力(尤其是复核、批量检查、并行任务)
  • 更适合执行“执行层 + 评估层”双层流程
  • 命令行闭环更完整,适合持续迭代

建议让 AI 先读取:

  1. CLAUDE.md
  2. START_HERE.md
  3. AI入口_统一指令.md
  4. 你当前步骤对应的模板文件

推荐首条消息:

请先读取 CLAUDE.md、START_HERE.md、AI入口_统一指令.md,然后带我完成第一步,不要提前写正文。

方式 B:Cherry Studio(新手友好)

优势:

  • 可视化界面更直观
  • 新手上手更轻松

边界:

  • 在复杂多 Agent 编排和长链路协作上,通常不如 Codex / Claude Code 可控
  • 更适合轻量创作与流程体验,不一定能发挥“最强协作模式”

如果你用的是 Cherry Studio,可以先看官方文档:

方式 C:OpenClaw / 柴油C6 集成

接入时,第一轮只需要先帮用户分流:

  • 从零开始写新小说
  • 导入已有小说

分流后再进入具体步骤,不要一上来问很多问题。


项目结构

Craft Companion/
├── tools/
├── novel-knowledge-mcp-server/
├── docs/
├── 提示模板/
│   ├── 从零开始/
│   ├── 导入已有小说/
│   └── 通用流程/
│
└── 你的项目/
    ├── CLAUDE.md
    ├── START_HERE.md
    ├── 提示模板/
    ├── docs/
    ├── tools/
    ├── 知识库/
    ├── 工作区/
    └── _归档/

核心特点

  • 结构化知识库:人物、设定、故事进展、写作参考分层维护
  • 5 阶段工作流:减少 AI 跑偏
  • 提示模板双入口:从零开始 / 导入已有小说
  • 隐私优先:本地使用,不上传私人创作资料
  • Harness 思路:不靠“玄学 prompt”,而靠稳定流程

文档

  • docs/01-快速开始.md
  • docs/02-知识库设计理念.md
  • docs/03-导入现有作品.md
  • docs/04-工作流详解.md
  • docs/05-自定义与扩展.md
  • docs/06-Cherry-Studio使用指南.md
  • docs/07-架构设计原则.md
  • docs/08-检查点机制.md
  • docs/09-评估层与复核机制.md
  • docs/10-ClaudeCode与Codex上手指南.md
  • docs/11-连接错误排查.md
  • docs/12-发布与更新展示规范.md
  • docs/13-体验验收与一致性检查清单.md
  • docs/releases/v1.2.0.md

当前建议

如果你是第一次用,不要直接看所有文档。先做这四件事:

  1. node tools/init.js
  2. 打开 START_HERE.md
  3. 运行 craft-companion doctor
  4. 按你的模式完成第一步模板

这样最快,不容易绕晕。

如果你是导入已有本地项目,建议先运行:

craft-companion bootstrap-entry
craft-companion doctor