SuperAPI AI 工具集

project-help

编程与开发

查看项目

更新于 11-04 19:59

技能介绍

用途

project-help 是一个只读、终端的帮助技能,用于回答关于「.claude 框架在当前项目中如何配置」以及「本项目自身关键技术、架构与结构知识」的问题。它强调答案必须来自本次会话运行的生成器输出,而不是记忆或推测。

主要能力

  • 框架清点:说明 .claude 框架是什么、各层做什么,以及当前存在哪些技能、智能体、工作流、钩子。
  • 技能目录检索:列出可用技能,或按关键词过滤。
  • 项目结构:说明代码位置与项目结构。
  • 技术栈:说明技术栈、架构、数据库、部署相关信息。
  • 测试与验证:列出测试、验证或应运行的命令。
  • 文档索引:列出已有参考文档及各自用途。
  • 全量输出:在目标不明确时运行 --all。

使用方式

按路由表分类后运行对应命令,例如:

  • node .claude/skills/project-help/scripts/project-overview.cjs --framework
  • node .claude/skills/project-help/scripts/project-overview.cjs --skills(或 --skills=<term>)
  • node .claude/skills/project-help/scripts/project-overview.cjs --structure
  • node .claude/skills/project-help/scripts/project-overview.cjs --stack
  • node .claude/skills/project-help/scripts/project-overview.cjs --commands
  • node .claude/skills/project-help/scripts/project-overview.cjs --docs
  • node .claude/skills/project-help/scripts/project-overview.cjs --all

展示规则:先打印所运行的命令,再逐字展示其输出,最后补充用户要求的解读。配置选项类问题(如可设置什么、谁读取某选项)应转交 $project-config --help;初始化相关问题转交 $project-init --help;框架配置命令用法转交 $framework-config --mode=help。

适用场景

  • 想了解当前项目的 .claude 框架接线与各层职责。
  • 想知道项目里有哪些技能、是否有某个技能。
  • 想了解项目结构、代码位置、技术栈、架构、数据库与部署。
  • 想了解如何测试或验证项目。
  • 想找到应阅读的参考文档。

限制

  • 只读且终端操作:不扫描、不编辑项目文件、不提出变更;如需变更转交 $project-config 或 $project-init。
  • 答案中的每个数字、路径和名称都必须来自本次会话运行的命令;不得凭记忆回答。
  • 必须先逐字展示生成器输出,再做解读,不得将其概括掉。
  • 配置选项问题不在本技能范围内,应委托给 $project-config --help。
  • 永远不打印机密信息;若某值看起来像凭证,只报告键名并停止。
  • 消费方计数是名称引用计数,不是调用图;引用时需说明。
  • 配置助手的 --current 只报告声明值与默认值,有效性验证属于 $project-config --validate。
  • 若文档被列为已配置但磁盘缺失,应报告缺口并指出负责的 $scan --target=…,不在本技能中创建。
  • Codex 兼容说明:通过 $skill-name 加载已注册的 .agents/skills/<name>/SKILL.md 并用宿主工具执行,无需单独 Skill 工具或 Claude 模式切换;需将外部工具名映射到可用的宿主能力。