# agent-flow

**Repository Path**: lyxstart/agent-flow

## Basic Information

- **Project Name**: agent-flow
- **Description**: 用于一站式设计-前端-后台-运维的AI流程框架（适用于Cursor、Claude Code 、Codex）
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-29
- **Last Updated**: 2026-07-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 通用 AI 辅助开发框架

> 一个跨 Cursor、Codex CLI、GitHub Copilot、Claude Code 的轻量级 AI 开发工作流框架。
> 不依赖任何 IDE 插件或专有命令系统，纯 Markdown + Prompt 模板。

---

## 适用场景

- 你的团队使用多种 AI 编程工具（Cursor、Codex、Claude Code、Copilot 等）。
- 你希望用一套统一的文档和流程管理 AI 辅助开发。
- 你想要类似 `.claude/` 的工作流，但不想被锁定在 Claude Code 生态。

## 设计哲学

1. **AGENTS.md 是唯一通用事实源**：所有工具都读它。
2. **Agent 规则做细化**：`.agents/rules/*.mdc` 只放各 AI 工具通用、或需要 globs 的细化规则。
3. **Claude Code 通过 shim 兼容**：`CLAUDE.md` 只有一行 `@AGENTS.md`。
4. **Prompt 模板替代斜杠命令**：`.agents/prompts/` 下提供各阶段可用的 prompt，复制到聊天框即可使用。
5. **项目状态文件替代自动记忆**：`docs/PROJECT_STATUS.md` 人工维护，跨工具通用。

## 快速开始

1. 把整个 `ai-framework/` 目录复制到你的新项目根目录。
2. 在新项目根目录执行：
   - `cp ai-framework/AGENTS.md ./AGENTS.md`
   - `cp ai-framework/CLAUDE.md ./CLAUDE.md`
   - `cp -r ai-framework/.agents ./.agents`
3. 填写 `AGENTS.md` 里的项目概述。
4. 创建 `Product-Spec.md`（或用 `.agents/prompts/prd.md` 开始）。
5. 创建 `docs/PROJECT_STATUS.md` 并维护。

详见 `docs/setup.md`。

## 目录说明

`	ext
ai-framework/
├── AGENTS.md                    # 跨工具主指令文件
├── CLAUDE.md                    # Claude Code shim（@AGENTS.md）
├── .agents/                     # Agent 配置目录
│   ├── rules/                   # Agent 细化规则
│   │   ├── 00-core.mdc          # 核心铁律，alwaysApply
│   │   ├── coding-style.mdc     # 编码规范
│   │   ├── testing.mdc          # 测试规范
│   │   ├── security.mdc         # 安全规范
│   │   ├── review.mdc           # 审查规范
│   │   └── workflow.mdc         # 工作流提示
│   └── prompts/                 # 各阶段 prompt 模板
│       ├── prd.md
│       ├── design.md
│       ├── plan.md
│       ├── dev.md
│       ├── review.md
│       ├── test.md
│       ├── fix.md
│       └── ship.md
├── templates/                   # 文档模板
│   ├── product-spec-template.md
│   ├── architecture-template.md
│   ├── plan-template.md
│   └── project-status-template.md
├── docs/
│   └── setup.md                 # 使用说明
└── README.md
`

## 与原版 `.claude/` 模板的区别

| 原版 `.claude/` 模板 | 本框架 |
|---------------------|--------|
| 依赖 Claude Code 的 `/xxx` 命令 | 使用 `.agents/prompts/` 下的 prompt 模板 |
| 依赖 `superpowers` 插件 | 不依赖任何插件 |
| `.claude/memory/CONTEXT.md` 自动更新 | `docs/PROJECT_STATUS.md` 人工维护 |
| `.claude/hooks/*.js` 自动触发 | 无 hooks，靠 prompt 里明确要求 |
| `.claude/agents/*.md` 子 agent | `.agents/prompts/` 下可手动调用的 agent prompt |
| `.claude/skills/*.md` skill | 直接是 prompt 模板 |
| 仅 Claude Code 可用 | Cursor + Codex + Copilot + Claude Code 通用 |

## 迁移建议

如果你已经有一个 `.claude/` 项目模板，想迁移到本框架：

1. 把 `CLAUDE.md` 中的工作流和规则迁移到 `AGENTS.md`。
2. 把 `.claude/rules/*.md` 拆成 `.agents/rules/*.mdc`。
3. 把 `.claude/commands/*.md` 和 `.claude/skills/*/*.md` 改写成 `.agents/prompts/*.md`。
4. 把 `.claude/agents/*.md` 改写成 `.agents/prompts/` 下的专用 prompt。
5. 把 `.claude/memory/CONTEXT.md` 的维护逻辑改成 `docs/PROJECT_STATUS.md`。

## 注意事项

- 本框架不是官方模板，是社区最佳实践的整理。
- 不同 AI 工具对 `AGENTS.md` 的解析深度不同，建议关键规则同时在 `.agents/rules/*.mdc` 中保留一份。
- `AGENTS.md` 建议控制在 300 行以内，避免超出 Codex 的 32 KiB 默认限制。