GitFlow项目管理工具

🚀 GitFlow for PM

贡献代码而不头痛

GitFlow for PM允许您使用简单的英语对代码库进行更改。只需告诉你的AI助手你想做什么，它就会为你处理所有Git的复杂性。

无终端命令。没有Git知识。描述一下你想要什么。

🎯 专为Vibe编码工具设计

与所有主要的AI编码助手配合使用：

✨ 你能做什么？

|你说。..|发生了什么| |------------|--------------| |“我可以处理哪些仓库？”|显示您可访问的项目| |“设置网站项目”|下载并准备代码| |“保存我的更改”|创建工作检查点| |“我完成了，发送审核”|推送你的代码并创建一个PR链接进行分享| |“我在做什么？”|显示您最近的工作会议| |“返回定价任务”|切换到以前的工作| |“跳”|我们问有多高|

📋 开始前（检查表）

您需要下载并安装这些工具。别担心，每个都有一个简单的安装程序！

⚠️ 重要提示：启动Docker/Rancher！

安装后 Docker 桌面版 或 牧场主桌面, 打开应用程序，让它在后台运行.

• Docker桌面： 寻找鲸鱼🐳 菜单栏中的图标
• 牧场主桌面： 在菜单栏中查找Rancher图标

Rancher用户注意事项： Rancher Desktop使用相同的 docker compose 命令，所以所有指令的工作方式都是一样的！

🛠️ 安装（逐步）

第一步：打开终端

在Mac上：

• 按 Cmd + Space，键入“终端”，按Enter键

在Windows上：

• 按 Win + R，键入“cmd”，按Enter键

第二步：下载项目

复制并粘贴此命令，然后按Enter键：

git clone https://github.com/asaprivate/gitflow-for-pms.git
cd gitflow-for-pms

步骤3：安装依赖项

npm install

步骤4：创建配置文件

cp .env.example .env

注： 如果 .env.example 不存在，请创建一个名为的新文件 .env 并添加下一节的内容。

步骤5：配置您的 .env 文件

💡 提示： 对于Mac用户：如果在Finder中看不到.env文件，请按Cmd+Shift+。（句号）以显示隐藏的文件。

打开 .env 在任何文本编辑器中创建文件并添加以下设置：

# =============================================================================
# GitFlow MCP Server Configuration
# =============================================================================

# Environment
NODE_ENV=development
LOG_LEVEL=debug
PORT=3000

# Database (Docker will set this up for you)
DATABASE_URL=postgresql://gitflow:gitflow_secret@localhost:5432/gitflow_dev

# GitHub OAuth (Get these from GitHub - see instructions below)
GITHUB_CLIENT_ID=your_client_id_here
GITHUB_CLIENT_SECRET=your_client_secret_here
GITHUB_REDIRECT_URI=http://localhost:3000/oauth/callback

# JWT Security (You can leave these as-is for development)
JWT_SECRET=your-super-secret-jwt-key-change-in-production
JWT_EXPIRES_IN=7d
JWT_ISSUER=gitflow-for-pms

# Redis (Docker will set this up for you)
REDIS_URL=redis://localhost:6379

# Stripe (Optional - for billing features)
STRIPE_SECRET_KEY=sk_test_xxx
STRIPE_WEBHOOK_SECRET=whsec_xxx
STRIPE_PRO_PRICE_ID=price_xxx

步骤6：获取您的GitHub凭据

您需要创建一个GitHub OAuth应用程序来连接您的帐户：

1. 首选 GitHub开发人员设置
2. 点击 “OAuth应用程序” → “新OAuth应用程序”
3. 填写：
   • 应用程序名称： GitFlow for PMs
   • 主页网址： http://localhost:3000
   • 授权回调URL: http://localhost:3000/oauth/callback
4. 点击 “注册申请”
5. 复制 客户端ID → 粘贴到 GITHUB_CLIENT_ID 在你的 .env
6. 点击 “生成新的客户端密钥”
7. 复制 客户端密钥 → 粘贴到 GITHUB_CLIENT_SECRET 在你的 .env

步骤7：启动数据库

确保Docker桌面（或Rancher桌面）正在运行，然后：

docker compose up -d db redis

您应该看到类似以下内容：

✔ Container gitflow-postgres  Started
✔ Container gitflow-redis     Started

步骤8：设置数据库表

npm run migrate

步骤9：构建服务器

npm run build

🎉 安装完成！ 现在，让我们将其连接到您的AI编码工具。

🔌 连接到您的AI工具

选择下面的AI编码工具并按照说明进行操作。

💡 提示： 在配置之前，通过运行以下命令查找项目路径 pwd 在终端中（在项目文件夹中）。你需要下面这条路。

示例路径：

• 雨衣： /Users/yourname/gitflow-for-pms
• 窗户： C:\Users\yourname\gitflow-for-pms

🤖 选项A：克劳德桌面

步骤1：查找您的Claude配置文件

在Mac上：

open ~/Library/Application\ Support/Claude/

在Windows上：

%APPDATA%\Claude\

第二步：编辑 claude_desktop_config.json

如果文件不存在，请创建它。添加以下配置：

{
  "mcpServers": {
    "gitflow": {
      "command": "node",
      "args": ["/FULL/PATH/TO/gitflow-for-pms/dist/index.js"],
      "env": {
        "NODE_ENV": "development",
        "DATABASE_URL": "postgresql://gitflow:gitflow_secret@localhost:5432/gitflow_dev",
        "REDIS_URL": "redis://localhost:6379",
        "GITHUB_CLIENT_ID": "your_client_id_here",
        "GITHUB_CLIENT_SECRET": "your_client_secret_here",
        "GITHUB_REDIRECT_URI": "http://localhost:3000/oauth/callback",
        "JWT_SECRET": "your-super-secret-jwt-key-change-in-production"
      }
    }
  }
}

⚠️ 重要提示： 替换 /FULL/PATH/TO/gitflow-for-pms 根据您的实际项目路径。

步骤3：重新启动克劳德桌面

完全退出Claude Desktop并重新打开它。GitFlow工具现在应该可用了！

步骤4：验证它是否正常工作

在克劳德，试着问：

“你有什么GitFlow工具？”

Claude应该列出以下工具 list_repositories, save_changes, push_for_review等等。

✏️ 选项B：光标

Cursor为MCP服务器使用JSON配置文件，类似于Claude Desktop。

步骤1：打开MCP设置

1. 打开 光标
2. 按 ⌘ + , （Mac）或 Ctrl+， （Windows）打开“设置”
3. 点击 “工具和MCP” 在左侧边栏中

步骤2：打开配置文件

1. 点击 “+新MCP服务器”
2. 这将打开 mcp.json 编辑器中的配置文件

💡 配置文件位置： 通常在 ~/.cursor/mcp.json

步骤3：添加GitFlow配置

将以下内容粘贴到 "mcpServers" 对象：

"gitflow": {
  "command": "node",
  "args": ["/ABSOLUTE/PATH/TO/gitflow-for-pms/dist/index.js"],
  "env": {
    "NODE_ENV": "development",
    "DATABASE_URL": "postgresql://gitflow:gitflow_secret@localhost:5432/gitflow_dev",
    "REDIS_URL": "redis://localhost:6379",
    "GITHUB_CLIENT_ID": "your_client_id_here",
    "GITHUB_CLIENT_SECRET": "your_client_secret_here",
    "GITHUB_REDIRECT_URI": "http://localhost:3000/oauth/callback",
    "JWT_SECRET": "your-super-secret-jwt-key-change-in-production"
  }
}

⚠️ 重要提示：

• 替换 /ABSOLUTE/PATH/TO/gitflow-for-pms 使用您的实际项目路径
• 替换 your_client_id_here 和 your_client_secret_here 使用您的GitHub OAuth凭据
• 如果您已经配置了其他MCP服务器，请在此块之前添加逗号

💡 找到你的路： 在终端中，导航到项目文件夹并运行 pwd.

例子： /Users/yourname/gitflow-for-pms/dist/index.js

步骤4：保存并重新启动

1. 保存 mcp.json 文件
2. 完全重新启动游标（退出并重新打开）

步骤5：验证连接

寻找 绿色状态指示器 🟢 MCP列表中“gitflow”旁边。

如果您看到连接错误： 确保Docker/Rancher正在运行，数据库已启动(docker compose up -d db redis).

🔷 选项C:Base44

Base44遵循标准MCP协议配置。

步骤1：打开MCP设置

在Base44中，导航到MCP服务器配置（通常在设置或首选项中）。

步骤2：添加服务器配置

使用以下设置添加新的MCP服务器：

步骤3：配置环境变量

添加上面游标部分中列出的相同环境变量，或确保 .env 文件已加载。

步骤4：重新启动Base44

重新启动应用程序以激活GitFlow工具。

🌐 选项D：其他MCP兼容工具

GitFlow for PM使用标准 模型上下文协议（MCP） 和 stdio 运输。

配置详细信息：

• 运输： stdio
• 命令： node
• 论据： ["/path/to/gitflow-for-pms/dist/index.js"]
• 环境变量： 请参阅上面光标部分的表格

有关如何添加MCP服务器，请参阅工具的文档。

📖 如何使用（备忘单）

连接后，只需自然地与您的AI助手交谈。以下是一些示例提示：

🚀 入门指南

💾 保存您的工作

📤 发送以供审核

🔄 管理多个任务

💡 专业建议

1. 经常保存 --每次保存都是一个可以返回的检查点
2. 描述你的工作 --“保存更改：添加了新的定价层”有助于跟踪您所做的操作
3. 寻求帮助 --你的人工智能助手可以用简单的语言解释正在发生的事情
4. 别担心树枝 --该工具会自动处理

🔧 故障排除

❌ “数据库连接错误”

问题： 数据库未运行。

解决方案：

1. 确保 Docker 桌面版 或 牧场主桌面 已打开并正在运行
   • Docker：寻找鲸鱼🐳 菜单栏中的图标
   • Rancher：在菜单栏中查找Rancher图标
2. 运行此命令：
   复制

   docker compose up -d db redis
   

3. 等待10秒，然后重试

❌ “身份验证错误”或“GitHub错误”

问题： 您的GitHub凭据错误或丢失。

解决方案：

1. 检查你的 .env 文件（或MCP配置）是否正确 GITHUB_CLIENT_ID 和 GITHUB_CLIENT_SECRET
2. 确保您从以下位置正确复制了它们 GitHub开发人员设置
3. 重建项目：
   复制

   npm run build
   

❌ “找不到MCP服务器”

问题： 你的AI工具找不到GitFlow服务器。

解决方案：

1. 检查以下路径 dist/index.js 配置正确
2. 确保你跑了 npm run build 安装后
3. 完全退出并重新启动AI工具（Claude、Cursor或Base44）

❌ “找不到命令：节点”

问题： Node.js未安装或不在您的PATH中。

解决方案：

1. 从以下位置安装Node.js nodejs.org （选择“LTS”）
2. 重新启动终端
3. 通过运行以下命令进行验证： node --version

❌ “权限被拒绝”错误

问题： 该工具无法访问某些文件。

解决方案：

• 在Mac上，您可能需要在“系统首选项”中授予终端全磁盘访问权限→ 隐私和安全

🆘 仍然卡住？

1. 检查日志：
   复制

   docker compose logs -f
   

2. 重置所有内容并重新开始：
   复制

   docker compose down -v
   docker compose up -d db redis
   npm run migrate
   npm run build
   

3. 完全重新启动您的AI工具

📚 更多资源

• AI使用指南 --AI助手工作原理的详细指南
• GitHub问题 --报告错误或请求功能

🙋 常见问题

我需要了解Git吗？

不！ 这就是重点。GitFlow处理所有Git的复杂性。你只需用简单的英语描述你想要什么。

我能打碎什么东西吗？

不太可能。 该工具可防止直接推入主管道等危险操作。在工程师审查之前，您的更改始终位于单独的分支上。

如果我犯了错误怎么办？

您始终可以返回到以前的保存。只要问“我做了什么改变？”然后从那里开始工作。

工程师需要改变他们的工作流程吗？

号码 工程师仍然以他们一贯的方式审查和合并PR。他们只是从你那里得到一个公关链接，而不是你要求他们做出改变。

多人可以使用这个吗？

对！每个人都有自己的会议和工作区。该工具跟踪谁在做什么。

📄 许可证

MIT许可证——见 许可证 了解详情。

GitFlow for PMs — Empowering Product Managers to contribute to code 🚀