v0.6.5 离线 CLI Node 18+ MIT

给 AI 编码
铺一层规范地基

运行 flow 进入交互工作台，↑↓ 选择即可生成 .agentflow/ 骨架与薄入口。不编排工作流，不绑定编辑器，不强制模型。

快速开始 查看源码
npm i -g @wnddd8339/flow && flow
flow — zsh

Why Flow

基础设施，不是编排器

Flow 只做规范层的「地基」——结构、入口、存在性检查。文档正文与维护靠 AGENTS.md 契约，由 AI 与开发者完成。

★

交互工作台

在终端里直接运行 flow，一屏看清项目状态，↑↓ 选择就能 init / check / prompts。

  • System Status 实时显示阶段、健康、已启用编辑器
  • Quick Wizard 数字快捷键 + ↑↓ 菜单双模式
  • init 完自动给出下一步指引，状态即时刷新
  • Windows CMD 不可用时降级为 flow › 输入
01

边界分明的骨架

规范骨架位于 .agentflow/docs/：project / conventions / business / pitfalls 各司其职，顶部「只写 / 不写」声明防止信息堆成一个大 README。

02

按需薄入口

只为你用的平台生成 CLAUDE.md、.cursor/rules 等指针，默认不堆满六个工具目录。

03

契约靠提示词

AGENTS.md 写明首次接手、大改动同步、完成自检；Flow 不拦截、不 hook、不强制模型。

04

始终生成的规范目录

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

check 验存在与漂移

flow check 确认骨架与已启用入口齐全，检测薄入口漂移与未填章节；仍兼容旧版平铺路径并提示迁入 docs/。

06

项目级编辑器配置

启用列表写入 .agentflow/editors.yaml，每个项目独立配置，不会跨仓库污染。

How it works

三步接入任意仓库

STEP 01

init 铺地基

终端里 ↑↓ 分步选择编辑器，或命令行指定；生成 .agentflow/ 与薄入口指针。

STEP 02

AI 读规范填骨架

各工具读到薄入口 → AGENTS.md → 分析代码库，填写 docs/ 下 project 等章节；或复制 prompts.md 话术触发。

STEP 03

日常协作 + check

改动后按契约更新文档；flow check 随时确认文件齐全。

Scope

做什么，不做什么

只做

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

不做

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

Quickstart

快速开始

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

flow init --skeleton-only         # 仅 .agentflow/
flow check                        # 存在性 + 漂移 + 骨架是否已填
flow prompts                      # 可复制触发话术（prompts.md）

CLI

命令参考

flow进入交互工作台（仪表盘 + ↑↓ 菜单：init / check / prompts）
flow init无参数时在终端 ↑↓ 分步选择；空格多选、回车确认
flow init [编辑器...]codex / claude / cursor / kiro / qoder / antigravity，可组合
flow init claude骨架 + Claude Code 薄入口（CLAUDE.md）
flow init cursor骨架 + Cursor 薄入口
flow prompts打印 .agentflow/prompts.md — 首次接手 / 大更新 / 完成自检等可复制话术
flow init --skeleton-only仅骨架，不生成薄入口
flow check检查骨架与已启用入口；检测漂移与未填章节（doctor 为别名）
flow editors list查看 / 管理启用的编辑器
flow tools检测本机 AI 编码 CLI 是否在 PATH
flow instructions打印 agent 工作说明摘要

Principles

设计原则

轻巧离线 CLI，最小依赖，不接管开发流程
地基优先只产结构与指针，内容交给 AI 与开发者
按需铺入口不默认生成六个平台目录
边界分明每份文档有只写 / 不写声明
契约靠提示词Flow 不拦截、不强制
平台中立支持多入口，不做深度绑定

在你的仓库里试一下

一行安装，一行 init。让下一个接手的 AI 先读规范，再写代码。

npm 安装 Star on GitHub