用途
speckit-check 用于确认 Spec Kit 的运行环境是否已正确准备。它执行 specify check,验证 Spec Kit CLI 以及一系列必需工具(git、claude、gemini、code、cursor-agent、windsurf、qwen、opencode、codex、shai、qoder 等)是否已安装且可被检测到。
何时使用
- 使用 speckit-initial 初始化项目后,确认环境配置。
- 当斜杠命令未出现,或用户反馈“specify 不工作”时。
- 在 CI 或脚本中,用于在运行 Spec Kit 各步骤前确保依赖已就绪。
前提条件
Specify CLI 必须已安装(参见 speckit-install)。如果 specify 不在 PATH 中,应先引导用户使用 speckit-install,再运行 specify check。
工作流程
- 确保 CLI 可用:如果用户尚未安装 CLI,或报告“specify: command not found”,先引导其使用 speckit-install。在 specify 可用之前不要运行
specify check。 - 运行检查:从项目根目录(或目标目录)执行
specify check。命令会报告检测到哪些工具(如 git、claude、gemini、code、cursor-agent、windsurf、qwen、opencode、codex、shai、qoder),以及哪些缺失或不在 PATH 中。 - 解读输出:
- 所有必需工具存在:环境已就绪,建议继续 speckit-constitution 或 speckit-specify。
- CLI 缺失:引导至 speckit-install。
- 代理或编辑器缺失:建议安装对应代理/编辑器,或将其可执行文件加入 PATH。如果用户只需要模板和 .specify/(不需要斜杠命令),建议使用
--ignore-agent-tools重新运行 speckit-initial。
- 总结并建议:提供简短总结(哪些正常、哪些缺失),并给出具体后续步骤:安装 CLI(speckit-install)、用不同的代理重新初始化(speckit-initial),或修复 PATH / 安装代理。
输出
- 总结:检测到哪些工具,缺失哪些工具。
- 建议:后续操作列表(安装 CLI、运行初始化、安装代理、加入 PATH,或使用
specify init --ignore-agent-tools)。
后续步骤
- 如有缺失:使用 speckit-install(针对 CLI)或 speckit-initial(重新初始化或使用
--ignore-agent-tools),或安装缺失的代理/编辑器。 - 如检查通过:继续 speckit-constitution 或 speckit-specify。
示例输出
参见 examples/sample-output.md 了解 specify check 输出示例及其解读方式。
故障排查
- “specify: command not found”:使用 speckit-install。
- 代理被报告缺失:确保代理应用已安装,且其 CLI 或可执行文件在 PATH 中;或者如果只需要模板,使用
specify init --ignore-agent-tools。 - Git 缺失:安装 git,或如果工作流不需要 git,运行
specify init --no-git。
参考
GitHub spec-kit —— CLI:specify check