vibe-coding-prompt-template

环境要求

• Node.js 环境（需能执行 npx 命令）
• AI 编程助手或 AI IDE，如 Cursor、VS Code
• 一个专门用于新应用的干净项目文件夹
• AI 助手需具备执行终端命令的能力（CLI 由 agent 驱动）

安装与启动步骤

1. 1准备项目文件夹

   新建一个干净的应用文件夹，用 AI IDE（Cursor 或 VS Code）打开它；本仓库只在开发工作流本身时才需要克隆。

2. 2让 AI 运行 CLI

   在 AI 助手中要求 agent 从你的项目文件夹执行该命令。CLI 是 agent 驱动的，不建议自己手动运行。

   npx vibeworkflow

   复制

3. 3创建 docs 目录

   在项目根目录创建 docs/ 文件夹，用于存放 PRD、技术设计与调研文档，后续脚手架依赖这个路径。

   mkdir docs

   复制

4. 4放入命名文档

   把文档按约定命名放进 docs/：PRD-[应用名]-MVP.md、TechDesign-[应用名]-MVP.md，可选 research-[应用名].md。

5. 5让 agent 搭建工作区

   在 IDE 的 AI 对话中说：Read part4-notes-for-agent.md, follow its instructions, and set up my workspace.，agent 会填充模板并生成工具配置。

6. 6校验搭建结果

   运行 doctor 检查工作区配置是否到位。它只检查搭建本身，构建和行为仍属于未验证状态。

   npx vibeworkflow doctor

   复制

7. 7预览将写入的文件

   想先确认会生成哪些文件时用 dry-run 预览并输出 JSON；已存在的文件默认保留，除非显式传入 --force。

   npx vibeworkflow --dry-run --json

   复制

8. 8安全自查并部署

   MVP 跑通后先过一遍密钥、鉴权、限流等安全检查，AI 功能再查提示注入边界与成本上限，然后按前端类型选 Vercel 或 Cloudflare Pages 部署。

关键配置

如何确认成功

运行 npx vibeworkflow doctor 通过，且项目根目录出现 AGENTS.md、MEMORY.md、REVIEW-CHECKLIST.md、agent_docs/ 等生成文件。

常见问题

注意事项

• 文档命名必须符合 PRD-[应用名]-MVP.md 与 TechDesign-[应用名]-MVP.md 约定，否则脚手架无法识别已有文档。
• 只有开发本工作流本身时才克隆该仓库；日常使用请在应用项目内通过 npx vibeworkflow 使用。
• 部署前务必完成安全自查与 AI 安全自查：依赖、密钥、鉴权路径、限流、提示注入边界、工具权限、日志与成本上限。