https://github.com/shotgun-sh/shotgun
The Shotgun CLI
https://github.com/shotgun-sh/shotgun
Last synced: 9 days ago
JSON representation
The Shotgun CLI
- Host: GitHub
- URL: https://github.com/shotgun-sh/shotgun
- Owner: shotgun-sh
- License: mit
- Created: 2025-08-05T08:53:12.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-10-07T08:51:36.000Z (about 2 months ago)
- Last Synced: 2025-10-11T02:15:52.821Z (about 2 months ago)
- Language: Shell
- Homepage: https://shotgun.sh/
- Size: 1.56 MB
- Stars: 156
- Watchers: 6
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-AI-driven-development - SHOTGUN - Spec Driven Development 🤠 Write codebase-aware specs for AI coding agents so they don't derail. (Project & Knowledge Management / Other IDEs)
README
### Spec-Driven Development
**Write codebase-aware specs for AI coding agents (Codex, Cursor, Claude Code) so they don't derail.**
[](https://shotgun.sh) [](https://x.com/ShotgunCLI) [](https://www.youtube.com/@shotgunCLI)
---
**Shotgun is a CLI tool** that generates codebase-aware specs for AI coding agents like Cursor, Claude Code, and Lovable. **It reads your entire repository**, researches how new features should fit your architecture, and produces technical specifications that keep AI agents on track—so they build what you actually want instead of derailing halfway through. **Bring your own key (BYOK) or use a Shotgun subscription — $10 for $10 in usage.**
It includes research on existing patterns, implementation plans that respect your architecture, and task breakdowns ready to export as **AGENTS.md** files. Each spec is complete enough that your AI agent can work longer and further without losing context or creating conflicts.
---
# 📦 Installation
### 1. Install uv
Shotgun runs via `uvx` or `uv tool install`. First, install `uv` for your platform:
Platform
Installation Command
macOS (Homebrew)
```bash
brew install uv
```
macOS/Linux (curl)
```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
```
Windows (PowerShell)
```powershell
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
```
_💡 Restart your terminal after installation_
### 2. Run Shotgun
🚀 Try It Out (Ephemeral)
⚡ Regular Use (Permanent)
**Best for:** Testing Shotgun first
```bash
uvx shotgun-sh@latest
```
No installation needed, runs immediately
**Best for:** Daily use
```bash
uv tool install shotgun-sh
```
Then run anywhere: ``` shotgun ```
_**Why uv?** It's 10-100x faster than pip and handles binary wheels reliably—no cmake/build tool errors._
### 3. Get Started
When you launch Shotgun, it will guide you through:
| Step | What Happens |
|------|--------------|
| **1. Codebase Indexing** | Builds a searchable graph of your entire repository |
| **2. LLM Setup** | Configure OpenAI, Anthropic, or Gemini |
| **3. First Research** | Start generating codebase-aware specs |
_**💡 Pro tip:** Run Shotgun in your IDE's terminal for the best experience._
> [!WARNING]
> **Upgrading from alpha?** Uninstall the old version first:
> ```bash
> npm uninstall -g @proofs-io/shotgun @proofs-io/shotgun-server
> ```
---
# 🎥 Demo
_Click the image above to watch the full demo on YouTube_
---
# 🎯 Usage
Shotgun's Terminal UI guides you through **5 specialized modes** — from research to export. Each mode has a dedicated AI agent optimized for that phase.
### Launch Shotgun in your project directory:
| Already Installed | First Time / Try It Out |
|-------------------|------------------------|
| `shotgun` | `uvx shotgun-sh@latest` |
_The TUI opens automatically. **Press `Shift+Tab` to switch modes** or `Ctrl+P` for the command palette._
### The 5-Phase Workflow
🔬 Research
Explore & understand
→
📝 Specify
Define requirements
→
📋 Plan
Create roadmap
→
✅ Tasks
Break into steps
→
📤 Export
Format for AI
_Each phase builds on the previous one, creating a complete specification ready for AI coding agents._
### Mode Reference
| Mode | What It Does | Example Prompt | Output |
|:-----|:-------------|:---------------|:-------|
| **🔬 Research** | Searches codebase + web, identifies patterns | `How do we handle authentication in this codebase?` | `research.md` |
| **📝 Specify** | Creates technical specs aware of architecture | `Add OAuth2 authentication with refresh token support` | `specification.md` |
| **📋 Plan** | Generates implementation roadmap | `Create an implementation plan for the payment system` | `plan.md` |
| **✅ Tasks** | Breaks plans into actionable items | `Break down the user dashboard plan into tasks` | `tasks.md` |
| **📤 Export** | Formats for AI coding agents | `Export everything to AGENTS.md` | `AGENTS.md` |
_**Mode switching:** `Shift+Tab` cycles through modes_
_**Visual status:** See current mode and progress at bottom_
### ⌨️ Keyboard Shortcuts
| Shortcut | Action |
|----------|--------|
| `Shift+Tab` | Switch modes |
| `Ctrl+P` | Open command palette |
| `Ctrl+C` | Cancel operation |
| `Escape` | Exit Q&A / stop agent |
| `Ctrl+U` | View usage stats |
### Tips for Better Results
| Do This | Not This |
|---------|----------|
| ✅ `Research how we handle auth` | ❌ Jump straight to building |
| ✅ `Shotgun please ask me questions first` | ❌ Assume Shotgun knows your needs |
| ✅ `I'm working on payments, need refunds` | ❌ `Add refunds` (no context) |
| ✅ Follow Research → Specify → Plan → Tasks | ❌ Skip phases |
**Result:** Your AI coding agent gets complete context—what exists, why, and what to build.
**Note:** CLI available in [docs/CLI.md](docs/CLI.md), but TUI is recommended.
---
# ✨ Features
### What Makes Shotgun Different
Feature
Shotgun
Other Tools
Codebase Understanding
Reads your entire repository before generating specs. Finds existing patterns, dependencies, and architecture.
Require manual context or search each time. No persistent understanding of your codebase structure.
Research Phase
Starts with research—discovers what you already have AND what exists externally before writing anything.
Start at specification. Build first, discover problems later.
Dedicated Agents Per Mode
Each mode (research, spec, plan, tasks, export) uses a separate specialized agent with prompts tailored specifically for that phase. 100% user-controllable via mode switching.
Single-agent or one-size-fits-all prompts.
Structured Workflow
5-phase journey with checkpoints: Research → Spec → Plan → Tasks → Export
No structure. Just "prompt and hope."
Export Formats
AGENTS.md files ready for Cursor, Claude Code, Windsurf, Lovable—your choice of tool.
Locked into specific IDE or coding agent.
### Case Study - Real Example:
We had to implement payments. Cursor, Claude Code, and Copilot all suggested building a custom payment proxy — 3-4 weeks of development.
⭐ Shotgun's research found [LiteLLM Proxy](https://docs.litellm.ai/docs/simple_proxy) instead—**30 minutes to discover, 5 days to deploy, first customer in 14 hours.**
****80% less dev time. Near-zero technical debt.****
### **[📖 Read the full case study](docs/CASE_STUDY.md)**
---
# Use Cases
- **🚀 Onboarding** - New developer? Shotgun maps your entire architecture and generates docs that actually match the code
- **🔧 Refactoring** - Understand all dependencies before touching anything. Keep your refactor from becoming a rewrite
- **🌱 Greenfield Projects** - Research existing solutions globally before writing line one
- **➕ Adding Features** - Know exactly where your feature fits. Prevent duplicate functionality
- **📦 Migration** - Map the old, plan the new, track the delta. Break migration into safe stages
**📚 Want to see a detailed example?** Check out our [Case Study](docs/CASE_STUDY.md) showing Shotgun in action on a real-world project.
---
# FAQ
**Q: Does Shotgun collect any stats or data?**
A: We only gather minimal, anonymous events (e.g., install, server start, tool call). We don't collect the content itself—only that an event occurred. We use Sentry for error reporting to improve stability.
**Q: Does my code leave my computer when indexing?**
A: No. When you index your codebase, all indexing happens locally on your machine. The index is stored in `~/.shotgun-sh/codebases/` and never sent to any server. Your code stays on your computer.
**Q: Local LLMs?**
A: Planned. We'll publish compatibility notes and local provider integrations.
**Q: What LLM providers are supported?**
A: Currently OpenAI, Anthropic (Claude), and Google Gemini. Local LLM support is on the roadmap.
**Q: Can I use Shotgun offline?**
A: You need an internet connection for LLM API calls, but your codebase stays local.
**Q: How does the code graph work?**
A: Shotgun indexes your codebase using tree-sitter for accurate parsing and creates a searchable graph of your code structure, dependencies, and relationships.
---
# Contributing
Shotgun is open-source and we welcome contributions. Whether you're fixing bugs, proposing features, improving docs, or spreading the word—we'd love to have you as part of the community.
### Ways to contribute:
- **Bug Report:** Found an issue? [Create a bug report](https://github.com/shotgun-sh/shotgun/issues/new?template=bug_report.md)
- **Feature Request:** Have an idea to make Shotgun better? [Submit a feature request](https://github.com/shotgun-sh/shotgun/issues/new?template=feature_request.md)
- **Documentation:** See something missing in the docs? [Request documentation](https://github.com/shotgun-sh/shotgun/issues/new?template=documentation.md)
**Not sure where to start?** Join our Discord and we'll help you get started!
### Development Resources
- **[Contributing Guide](docs/CONTRIBUTING.md)** - Setup, workflow, and guidelines
- **[Git Hooks](docs/GIT_HOOKS.md)** - Lefthook, trufflehog, and security scanning
- **[CI/CD](docs/CI_CD.md)** - GitHub Actions and automated testing
- **[Observability](docs/OBSERVABILITY.md)** - Telemetry, Logfire, and monitoring
- **[Docker](docs/DOCKER.md)** - Container setup and deployment
---
## 🚀 Ready to Stop AI Agents from Derailing?
**Research → Specify → Plan → Tasks → Export** — Five phases that give AI agents the full picture.
```bash
uvx shotgun-sh@latest
```
### ⭐ Star us on GitHub
### Star History
---
**License:** MIT | **Python:** 3.11+ | **Homepage:** [shotgun.sh](https://shotgun.sh/)
---
## Uninstall
```bash
uv tool uninstall shotgun-sh
```