squad

环境要求

• Node.js 22.5+（仅 npm 安装方式需要）
• 一个已 git init 的项目目录
• GitHub Copilot（Squad 团队基于它运行）
• 可选：gh CLI 与 gh-aw 扩展（用于安装工作流）

安装与启动步骤

1. 1创建项目并初始化

   新建项目目录并执行 git init，为 Squad 团队文件准备仓库。验证方式：运行 git status 应显示 No commits yet。

   mkdir my-project && cd my-project
   git init

   复制

2. 2安装 Squad CLI

   Node.js 22.5+ 环境下用 npm 全局安装，所有安装方式装到的都是同一个 CLI。注意：命令会写入全局 node_modules。

   npm install -g @bradygaster/squad-cli

   复制

3. 3初始化智能体团队

   在项目根目录运行 squad init，会一步步引导你完成团队配置。完成后项目内会生成 .squad/team.md。

   squad init

   复制

4. 4用预设快速开队

   希望立刻可用时改用该命令，直接生成带成员、章程和路由规则的完整团队配置，无需逐步引导。

   squad init --preset default

   复制

5. 5从源码本地安装

   开发调试用：在仓库根目录安装 npm workspaces 依赖，再直接运行 CLI 入口执行 init。注意 dist 产物需已构建。

   npm install
   node ./packages/squad-cli/dist/cli-entry.js init

   复制

6. 6运行测试

   源码开发方式下执行全部测试，确认本地环境可用。仅在克隆源码后需要执行。

   npm test

   复制

7. 7安装 GitHub 工作流

   用 gh aw add 拉取 Squad 的智能体工作流（会自动编译），随后把生成文件提交并推送。注意先审查完整 diff。

   gh aw add 
     bradygaster/squad/workflows/squad.md@dev 
     bradygaster/squad/workflows/squad-implement-worker.md@dev 
     bradygaster/squad/workflows/squad-review.md@dev 
     bradygaster/squad/workflows/squad-deps-worker.md@dev 
     bradygaster/squad/workflows/squad-retro.md@dev 
     bradygaster/squad/workflows/squad-improvement-worker.md@dev
   git add -- 
     .github/aw/ 
     .github/skills/ 
     .github/workflows/ 
     .gitattributes
   git commit -m "Add Squad workflow"
   git push

   复制

关键配置

如何确认成功

运行 squad init 后确认项目内生成了 .squad/team.md；步骤 1 中 git status 应显示 No commits yet。

常见问题

注意事项

• Squad 目前是 Alpha 实验软件，API 和 CLI 命令可能随版本变化，破坏性变更会记录在 CHANGELOG.md 中。
• 其他安装方式：macOS 可执行 brew install --cask bradygaster/squad/squad，Windows 可执行 winget install --id bradygaster.Squad --exact，也可从 GitHub Releases 下载归档。
• 预览版与内测版分别对应 squad-preview、squad-insider（Homebrew）以及 bradygaster.Squad.Preview、bradygaster.Squad.Insider（WinGet）。
• 提交 gh-aw 生成的文件时，.github/aw/、.github/skills/、.github/workflows/ 与 .gitattributes 建议一并提交，.vscode/ 是否提交可自行决定。