用途:本资料说明 Squad CLI 工具(create-squad)代码库的核心约定与模式,供修改 Squad 源码前参考。Squad 是零依赖 Node.js 包,可为任意项目加入 AI 智能体团队。
主要约定:零运行时依赖,仅用 Node.js 内置模块(fs、path、os、child_process),不得向 package.json 的 dependencies 添加包。测试使用 node:test 与 node:assert/strict,无测试框架,测试文件位于 test/,命令为 npm test,实际执行 node --test test/。
错误处理采用 fatal(msg) 模式:打印红色 ✗ 前缀并以退出码 1 结束,不抛出未处理异常或打印原始堆栈;全局 uncaughtException 处理器调用 fatal() 作为兜底。颜色使用 index.js 顶部常量 GREEN、RED、DIM、BOLD、RESET,不要内联 ANSI 转义码。
文件结构:.squad/ 为团队状态(用户所有,升级不覆盖);.squad/templates/ 为从 templates/ 复制的模板(Squad 所有,升级覆盖);.github/agents/squad.agent.md 为协调器提示(Squad 所有,升级覆盖);templates/ 为 npm 包附带源模板;.squad/skills/ 为 SKILL.md 格式团队技能(用户所有);.squad/decisions/inbox/ 为并行决策写入投递箱。
平台与流程:路径一律用 path.join(),不硬编码 / 或 \,须兼容 Windows、macOS、Linux,测试需全平台通过。init 采用 skip-if-exists 模式,文件或目录已存在则跳过并报告“already exists”,绝不覆盖用户状态;仅 upgrade 覆盖 Squad 自有文件。copyRecursive(src, target) 同时处理文件与目录,以 { recursive: true } 创建父目录,文件用 fs.copyFileSync。
代码片段保留原样:fatal、path.join、skip-if-exists 示例见资料,未提供更多安装命令。
反模式:添加 npm 依赖、硬编码路径分隔符、init 覆盖用户状态、原始堆栈、内联 ANSI 码。
限制:资料未提供 Squad 的收费、价格、平台支持细节、完整安装步骤或效果数据,暂未提供。