SuperAPI AI 工具集

speckit-check

编程与开发

查看项目

更新于 10-16 07:53

技能介绍

用途

Speckit-check 用于验证 Spec Kit 运行环境是否就绪。它运行 specify check 命令,检测 Spec Kit CLI 以及各种所需工具(git、AI 智能体、编辑器)是否已安装并可被检测到。

何时使用:

  • 使用 speckit-initial 初始化项目后,确认环境是否正常。
  • 当斜杠命令未出现,或用户反馈“specify 不工作”时。
  • 在 CI 或脚本中使用,确保依赖项在运行 Spec Kit 步骤前已就绪。

前置条件

Specify CLI 必须已安装(参见 speckit-install)。如果 specify 不在 PATH 中,应先指引用户执行 speckit-install,再运行 specify check。

主要能力

从项目根目录(或目标目录)运行:

specify check

该命令会报告哪些工具被检测到(例如 git、claude、gemini、code、cursor-agent、windsurf、qwen、opencode、codex、shai、qoder),以及哪些缺失或不在 PATH 中。

使用方式与工作流程

  1. 确保 CLI 可用:如果用户尚未安装 CLI,或报告“specify: command not found”,先指引其执行 speckit-install。在 specify 可用之前,不要运行 specify check。
  2. 运行检查:在项目根目录或目标目录执行 specify check。
  3. 解读输出:
    • 所有必需工具均存在:环境已就绪,建议继续进行 speckit-constitution 或 speckit-specify。
    • CLI 缺失:引导至 speckit-install。
    • 智能体或编辑器缺失:建议安装对应的 Agent/编辑器,或将其可执行文件加入 PATH。如果用户只需要模板和 .specify/(不需要斜杠命令),建议使用 --ignore-agent-tools 重新运行 speckit-initial。
  4. 总结与建议:提供简短总结——哪些正常、哪些缺失;并给出具体的后续步骤:安装 CLI(speckit-install)、使用不同智能体重初始化(speckit-initial)、修复 PATH / 安装 Agent 等。

输出内容

  • 摘要:哪些工具被检测到,哪些缺失。
  • 建议:后续操作列表(安装 CLI、运行初始化、安装 Agent、加入 PATH,或使用 specify init --ignore-agent-tools)。

后续步骤

  • 若有缺失:使用 speckit-install(针对 CLI)或 speckit-initial(重新初始化或使用 --ignore-agent-tools),或安装缺失的 Agent/编辑器。
  • 若检查通过:继续 speckit-constitution 或 speckit-specify。

故障排查

  • “specify: command not found”:使用 speckit-install。
  • 报告 Agent 缺失:确保 Agent 应用已安装,其 CLI 或可执行文件在 PATH 中;若仅需模板,可使用 specify init --ignore-agent-tools。
  • Git 缺失:安装 git,或如果工作流不要求 git,运行 specify init --no-git。

参考

GitHub spec-kit — CLI:specify check。示例输出可参见 examples/sample-output.md,其中给出了 specify check 输出的示例及解读方法。