npm i -g @wnddd8339/flow && flow

无需全局安装：npx @wnddd8339/flow init

是什么

规范层的「地基」工具

工作台 · 骨架 · 薄入口 · 存在性检查

不是什么

Agent 编排器 · hook 插件 · 文档代写器

怎么用

flow → ↑↓ 选 init → 勾选编辑器 → 打开 prompts.md 复制话术 → AI 填骨架

三步接入

工作台

在 Windows Terminal / Cursor 终端 / cmd 里直接运行 flow：

 _____ _
|  ___| | _____      __
| |_  | |/ _ \ \ /\ / /
|  _| | | (_) \ V  V /
|_|   |_|\___/ \_/\_/

 Flow · AI 编码规范工作台 · 离线 CLI

 ╭─ System Status ────────╮  ╭─ Quick Wizard ──╮
 │ Phase  not initialized │  │ 1 Setup / init  │
 │ Doctor —               │  │ 2 Doctor        │
 │ Editors none           │  │ 3 Prompts       │
 ╰────────────────────────╯  ╰─────────────────╯

 ● Setup / init — 选择编辑器   ‹推荐›
 ○ Check · ○ Prompts · ○ Tools

仪表盘 — 项目路径、阶段、健康、已启用编辑器，操作后实时刷新

↑↓ 菜单 — 选择动作、回车确认；不可用时降级为 flow › 输入

init 向导 — 空格勾选编辑器，PATH 上的默认勾选，完成后给出下一步指引

触发话术

init 会生成 .agentflow/prompts.md — 常见场景整段复制到 AI 对话框，不用自己拼提示词。

flow prompts    # 终端打印全文，或直接打开 .agentflow/prompts.md

快速开始

flow                          # 进入交互工作台（推荐）
flow init                     # ↑↓ 分步选择编辑器
flow init cursor claude       # 或直接指定多个平台

flow check                    # 检查骨架与薄入口
flow prompts                  # 查看可复制触发话术

npx @wnddd8339/flow init claude
npx @wnddd8339/flow init --skeleton-only

按编辑器配置

内置六种 AI 编码工具，一条命令生成对应薄入口：

flow init --skeleton-only        # 只要 .agentflow/，不要薄入口
flow init cursor claude          # 多平台 positional
flow init --editors qoder,cursor # 逗号分隔
flow init --force claude         # 覆盖已有 Flow 生成文件

生成物

始终生成 — .agentflow/ 规范目录

.agentflow/
├── AGENTS.md           总入口 + 维护契约
├── prompts.md          可复制触发话术
├── docs/               规范骨架（AI 填写）
│   ├── project.md      项目是什么
│   ├── conventions.md  怎么写代码
│   ├── business.md     业务是什么
│   └── pitfalls.md     踩过的坑
└── skills/README.md    skill 路由表

按需生成 — 薄入口指针

只为你勾选的平台创建文件，不会默认堆满六个工具目录。

每个薄入口只有一行指向 .agentflow/AGENTS.md，规范正文只维护一处。

做什么 · 不做什么

只做

• 生成结构清晰的规范文档骨架
• 按平台写入指向 AGENTS.md 的薄指针
• check 校验文件存在性与漂移
• editors 管理本项目启用哪些入口

不做

• 工作流编排、handoff、状态追踪
• 绑定某一编辑器的 hook / 插件
• 代替 AI 填写或校验文档内容
• 默认堆满六个平台文件夹

命令

完整介绍见 文档站点 →

设计原则

开发

git clone https://github.com/wnddd839/flow.git
cd flow
npm install
npm run check

| 版本 | 要点 | |------|------| | 0.6.5 | 规范骨架迁入 .agentflow/docs/，根目录更整洁 | | 0.6.4 | .agentflow/prompts.md 场景话术 · flow prompts | | 0.6.3 | 裸 flow 进入交互工作台 | | 0.6.2 | flow init ↑↓ 分步向导 · Windows TTY 修复 | | 0.6.1 | TypeScript 主线 · 项目级 editors.yaml · unfilled 检测 | | 0.6.0 | npm 首发 @wnddd8339/flow | | ≤0.5 | Python 版已归档至 archive/python/ |

Flow · MIT · GitHub · npm · 文档