详细介绍
Shotgun 是一个基于 Python 的命令行工具,旨在将抽象的开发想法转化为结构化的实现流程。它通过五个核心模式——研究、规格、计划、任务和实施——帮助开发者在 AI 辅助下完成从概念到代码的全过程。Shotgun 在操作前会索引整个代码库,构建可搜索的代码图谱,确保所有决策都基于实际的代码结构和依赖关系,从而提供更精准的上下文理解和建议。
主要特性
- 五种核心模式:研究 → 规格 → 计划 → 任务 → 实施,形成完整的开发工作流。
- 代码库全面理解:在开始任何工作前索引整个代码库,构建实时代码图谱。
- 确定性产物:生成的规格、计划和任务均为可版本控制的 Markdown 文档,便于审查和迭代。
- 多数据源查询:可同时查询代码库、网络、GitHub 和文档,提供全面的研究基础。
- 导出能力:支持导出至 agents.md 生态系统,兼容多种代码生成工具。
使用场景
- 新成员入职:快速映射整个架构,生成与实际代码匹配的文档。
- 重构项目:在修改前全面理解依赖关系,避免重构变成重写。
- 新功能开发:准确定位功能位置,防止重复实现。
- 项目迁移:映射旧系统、规划新架构、追踪变更差异,分阶段安全迁移。
- 团队协作:生成可版本控制的规格文档,促进知识共享和决策记录。
技术特点
- 基于 Python 构建,使用 pipx 进行隔离安装,30 秒即可完成部署。
- 支持多家 LLM 提供商,包括 OpenAI、Anthropic 和 Gemini。
- 实时代码图谱技术,确保所有建议都基于最新代码状态。
- 人机协同检查点,在关键决策点需要人工审核,保持控制权。
- 遥测和变更追踪功能,减少返工和夜间故障。