Skip to content

bamdra/vibeflow

Repository files navigation

Bamdra VibeFlow

Bamdra VibeFlow 是一套面向 AI 编程的开发工作流。它把需求入口、架构上下文、推进状态和执行约束沉淀为固定文件,让 Codex、Claude Code 以及其他本地代理都能在同一项目里按一致流程工作。

首版提供三部分能力:

  • 平台中立的 VibeFlow 规范与模板
  • 可直接安装的 Codex Skill
  • 可直接安装的 Claude Code commands 与聊天版降级说明

当前发布版本:v0.1.0

核心价值

  • 单一任务入口:统一通过 INSTRUCTIONS.md 接收需求
  • 最小改动执行:默认禁止无关重构、全局格式化和盲写
  • 文档协同更新:任务推进后同步 STATUS.md,涉及架构时同步 ARCH.md
  • 双端一致性:Codex 与 Claude Code 复用同一套模板与共享脚本
  • 隔离执行:run 模式在复杂任务中优先用 subagent 承载干净上下文
  • 可选增强:检测到 gstack / superpowers 时按场景调用,缺失时回退基础流程

仓库结构

.
├── vibeflow/                 # VibeFlow 规范与模板
├── scripts/                  # 共享脚本与安装工具
├── skills/
│   └── bamdra-vibeflow/      # Codex Skill
├── .claude/
│   └── commands/             # Claude Code commands
├── docs/                     # 说明文档
└── examples/
    └── minimal-project/      # 最小示例项目

快速开始

1. 安装 Codex Skill

python3 scripts/install_codex_skill.py

默认安装到 ~/.codex/skills/bamdra-vibeflow

2. 安装 Claude Code commands

python3 scripts/install_claude_commands.py

默认安装到 ~/.claude/commands/,并生成一份可合并到 ~/.claude/CLAUDE.md 的说明片段。

3. 在项目中初始化 VibeFlow 文件

推荐直接在 Claude Code 中进入目标项目根目录后执行:

/bamdra-vibeflow-init

它会检查当前目录是否已经具备 Bamdra VibeFlow 所需文件,并在缺失时引导创建:

  • INSTRUCTIONS.md:后续任务入口
  • ARCH.md:架构上下文
  • STATUS.md:推进状态
  • README.md:项目概览

底层也可以使用共享脚本预览或补齐:

python3 scripts/bamdra_vibeflow.py inspect --project /path/to/project
python3 scripts/bamdra_vibeflow.py scaffold --project /path/to/project --write

默认策略是安全确认:脚本只负责生成/补齐工作流文件,不会自动执行 git initgit remote addgit commit

验证安装

Codex

  1. 确认 ~/.codex/skills/bamdra-vibeflow/ 已存在
  2. 在 Codex 中发起一个带 VibeFlow 语义的请求,例如: 请用 Bamdra VibeFlow 初始化当前项目工作流文件
  3. 确认模型会优先检查 INSTRUCTIONS.mdSTATUS.mdARCH.md

Claude Code

  1. 确认 ~/.claude/commands/ 中已存在:
    • bamdra-vibeflow-init.md
    • bamdra-vibeflow-run.md
    • bamdra-vibeflow-sync.md
    • bamdra-vibeflow-status.md
  2. 确认 ~/.claude/CLAUDE.md 已包含 Bamdra VibeFlow 规则片段
  3. 在 Claude Code 中执行 /bamdra-vibeflow-status

共享脚本

python3 scripts/bamdra_vibeflow.py inspect --project examples/minimal-project
python3 scripts/bamdra_vibeflow.py summary --project examples/minimal-project

Claude Code commands

安装后,~/.claude/commands/ 中会包含 4 个命令文件。日常使用时在 Claude Code 中输入对应斜杠命令即可。

bamdra-vibeflow-init.md

Claude Code 命令:/bamdra-vibeflow-init

用途:初始化一个项目的 Bamdra VibeFlow 工作流文件。

推荐场景:

  • 新项目刚开始接入 Bamdra VibeFlow
  • 已有项目还没有 INSTRUCTIONS.mdARCH.mdSTATUS.mdREADME.md
  • 想先检查当前目录是否已经具备 AI 编程协作条件

执行效果:

  • 检查当前目录是否存在 .git
  • 检查 4 个工作流文件是否存在
  • 缺失时优先使用共享脚本预览要创建的内容
  • 用户确认后补齐必要文件
  • 不会自动执行 git initgit commit 或覆盖已有工作流文件

bamdra-vibeflow-run.md

Claude Code 命令:/bamdra-vibeflow-run

用途:按 Bamdra VibeFlow 执行当前任务,是开发过程中的主入口。

推荐场景:

  • 需要实现功能、修 bug、重构、跑验证或推进多步骤任务
  • 希望执行过程自动读取 VibeFlow 上下文并同步任务状态
  • 希望复杂任务使用 subagent 隔离执行,减少主会话上下文消耗

最佳实践:

  1. 只编辑 INSTRUCTIONS.md,把本轮任务、约束和验收标准写进去。
  2. 在 Claude Code 中执行 /bamdra-vibeflow-run
  3. 命令会先读取 INSTRUCTIONS.md -> ARCH.md -> STATUS.md -> 相关代码
  4. 复杂任务会优先由主会话拉起 subagent 执行,执行过程中可按需调用 gstack / superpowers。
  5. 完成代码修改后自动同步 STATUS.md,涉及架构事实变化时同步 ARCH.md

bamdra-vibeflow-sync.md

Claude Code 命令:/bamdra-vibeflow-sync

用途:只同步 VibeFlow 文档,不改业务代码。

推荐场景:

  • 没有使用 /bamdra-vibeflow-run,但已经做了大量代码更新
  • 项目发生了架构调整,需要补齐 ARCH.md
  • 当前任务状态、已完成事项、下一步计划和 STATUS.md 不一致
  • 接手一个上下文已经漂移的会话,希望重新拉齐工作流文件

执行效果:

  • 读取当前代码、Git 状态和已有工作流文件
  • 更新 STATUS.md 的 Done / Next Progress
  • 架构事实变化时更新 ARCH.md
  • 不修改业务代码
  • 不自动提交 Git

bamdra-vibeflow-status.md

Claude Code 命令:/bamdra-vibeflow-status

用途:检查当前项目的 VibeFlow 就绪程度。

推荐场景:

  • 想确认项目是否已经正确接入 Bamdra VibeFlow
  • 想快速查看缺失哪些工作流文件
  • 在执行任务前先获得当前 VibeFlow 状态摘要

执行效果:

  • 汇总 .git 与工作流文件状态
  • 输出当前项目是否 vibeflow-ready
  • 给出下一步建议
  • 不产生副作用

推荐工作流

初始化项目

  1. 进入项目根目录。
  2. 执行 /bamdra-vibeflow-init
  3. 根据提示补齐 INSTRUCTIONS.mdARCH.mdSTATUS.mdREADME.md
  4. /bamdra-vibeflow-status 确认项目已经 vibeflow-ready。

日常开发

  1. 只编辑 INSTRUCTIONS.md,写清楚本轮要做什么。
  2. 执行 /bamdra-vibeflow-run
  3. 让命令自动读取 VibeFlow 文件、分析代码、执行任务并同步 STATUS.md / ARCH.md
  4. 对代码修改、调试、实现、验证等任务,优先让 run 模式拉起 subagent 隔离执行。
  5. 如果环境中有 gstack 或 superpowers,把它们作为可选增强能力按场景调用。

拉齐已有改动

如果一段时间没有使用 Bamdra VibeFlow,但已经进行了大量代码更新、架构调整或任务推进:

  1. 先执行 /bamdra-vibeflow-status 查看当前 VibeFlow 状态。
  2. 再执行 /bamdra-vibeflow-sync
  3. 让它根据当前代码和事实同步 STATUS.md,必要时同步 ARCH.md
  4. 后续继续回到“只编辑 INSTRUCTIONS.md,再执行 /bamdra-vibeflow-run”的工作方式。

所有工作流都遵守安全边界:仅在用户明确确认后执行 Git 初始化、远程绑定、提交、推送或覆盖已有工作流文件。

文档

当前状态

当前版本为 v0.1.0 首次发布版,优先锁定:

  • 工作流文件约定
  • 安全确认策略
  • Codex Skill 与 Claude Code command 的统一行为

后续如果需要更强的分发能力,可以在不改动 VibeFlow 核心的前提下补充 Codex plugin 壳层。

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages