VERSION 0.20 / BEGINNER FRIENDLY

先让 Agent 把协作装好。

Vibe-Git 让多人 Agent 在同一个项目里共享提案、决策、任务和需求变更。本页是完整教程;官网只负责安装入口。

先记住:Skill 是教 Agent 如何协作的说明书;CLI 是真正创建房间、上传文件、发布任务和读取状态的工具。普通用户先安装 Skill,CLI 缺失时让 Agent 自动执行 npm 安装。

安装方式

Agent 自动安装(推荐)

先在项目工作区或平时使用 Agent 的目录执行:

INSTALL SKILL
npx skills add TFboy1/vibe-git-skill --skill vibe-git

然后把这句话直接发给 Agent:

请自动安装并配置 Vibe-Git:先检查 Node.js、Git、Codex CLI 和 vibe-git CLI;如果 CLI 没安装就执行 npm install -g @vibe-git/vibe-git,安装成功后先问我是队长还是队员,再带我完成第一步。

Agent 会检查环境、安装 CLI、运行 vibe-git --help,然后询问你的身份。用户明确要求自动安装时,Skill 不要求你再手动复制 npm 命令。

手动安装

如果 Agent 不允许执行终端命令,或者你想自己控制安装过程:

CLI INSTALL
npm install -g @vibe-git/vibe-git
vibe-git --help

手动安装 CLI 后,仍然建议安装 Skill,让 Agent 帮你完成后面的角色分流和提案上传。

可以使用哪些 Agent

只要智能体支持 Agent Skill、读取工作区和执行终端命令,就可以使用 Vibe-Git:

TraeCodexWorkBuddyCoderClaude CodeAntigravityCursorClineOpenCodeWindsurf

安装后先选择身份

不要一上来复制所有命令。你要创建房间并邀请别人,就是队长;你拿到别人发来的加入 URL,就是队员。

CAPTAIN / 队长

创建房间、定方案、发任务

YOUR PROJECT WORKSPACE
vibe-git host start
vibe-git open

host start 成功回执中的完整加入命令才是邀请入口,只发给预期队员。open 只是打开面板。

MEMBER / 队员

加入房间、提方案、做任务

YOUR PROJECT WORKSPACE
vibe-git connect "<队长给你的完整 URL>"
vibe-git status
vibe-git open

连接成功后让 Agent 阅读项目,先展示提案给你确认,再执行 plan submit。

队长的下一步

  1. 等待至少一位队员连接并上传提案。
  2. 运行 vibe-git status,再运行 vibe-git align start。
  3. 用真实的 alignment-id、issue-id 和 option-id 阅读并裁决冲突。
  4. 按需改派任务,最后运行 vibe-git tasks publish <alignment-id>。

队员的下一步

  1. 连接后运行 status 确认节点身份。
  2. 确认提案内容,再运行 vibe-git plan submit proposal.md。
  3. 收到任务后依次使用 task list、task pull、task start。
  4. Codex 结束后先 task sync,确认状态新鲜后再 task done。

每个功能怎么用

提案:PLAN

提案是每个成员自己的方案,不是任务细节,也不是需求变更单。

vibe-git plan submit proposal.md

文件必须是非空 UTF-8 Markdown,最大 256 KiB。重复内容幂等,修改内容生成新版本。Skill 可以帮你阅读项目、整理内容并上传。

对齐:ALIGN

队长发起对齐,冻结各节点最新提案,查看共同稿和冲突;未裁决的实质冲突不能发布任务。

vibe-git align start
vibe-git align status
vibe-git align show <alignment-id>
vibe-git align resolve <alignment-id> <issue-id> <option-id>

任务:BUILD

发布任务不等于自动开工。负责人要自己拉取、开始、同步和完成。

vibe-git task list
vibe-git task pull <task-id>
vibe-git task push <task-id> execution.md
vibe-git task start <task-id>
vibe-git task sync <task-id>
vibe-git task done <task-id>

Codex 审核池

每个节点可以绑定独立的专用 Codex 审核账号,用于检查需求变更的真实代码影响,不替换日常 Codex。

vibe-git codex bind
vibe-git codex status

出现 device-auth 页面时由用户完成授权,不要读取或公开审核账号凭据。

需求变更:CHANGE

pr submit 是 Vibe-Git 内部需求变更单,不会创建 GitHub Pull Request。建议包含原需求、修改内容、影响任务、兼容性和验收标准。

vibe-git pr submit change.md
vibe-git pr list
vibe-git review start --force
vibe-git review status
vibe-git review apply <review-id>

如果状态是 NEEDS_EVIDENCE,先补证,不要强行 apply。

高级能力:阶段、契约和工作流

普通项目可以暂时不用。复杂项目需要阶段和确认点时,再使用 stage、contract、work 和 align downgrade。

vibe-git stage activate <alignment-id>
vibe-git contract list
vibe-git contract ack <contract-id>
vibe-git work list
vibe-git work pull <workstream-id>

Skill 能帮你说人话

你不需要记住每个命令,只需要描述目标。确认内容后,Skill 会创建 UTF-8 Markdown 并调用对应 CLI。

  • “我是队长,检查当前工作区并启动 Vibe-Git 房间。”
  • “我是队员,这是队长的加入命令,帮我连接并确认状态。”
  • “阅读这个项目,生成提案,先展示给我确认,确认后自动上传。”
  • “我想修改登录流程,生成需求变更单,确认后提交 Vibe-Git 内部 PR。”
  • “帮我连接 Vibe-Git 专用 Codex 审核池。”
  • “读取当前状态,告诉我下一步应该执行哪个命令,不要猜 ID。”

安全边界

  • 加入命令包含注册密钥,只发给预期队员。
  • 不要公开 client.json、captain.json 或 audit-codex 凭据。
  • Skill 只在 CLI 成功回执后报告“已上传”“已连接”或“已完成”。
  • GitHub 管理代码提交;Vibe-Git 管理团队意图、任务和需求变更。

加入群聊

使用手机微信扫描二维码。图片标注二维码 7 天内有效(9 月 30 日前);失效后请等待项目重新发布新的二维码。

群二维码不是 Vibe-Git 房间加入链接。房间加入命令由队长通过 CLI 生成。

vibe-git 微信群聊二维码