shotgun-sh 0.2.5.dev1__tar.gz → 0.2.28.dev1__tar.gz

{shotgun_sh-0.2.5.dev1 → shotgun_sh-0.2.28.dev1}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Proofs.io
+Copyright (c) 2025 Mimir AI, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

shotgun_sh-0.2.28.dev1/PKG-INFO

@@ -0,0 +1,472 @@
+Metadata-Version: 2.4
+Name: shotgun-sh
+Version: 0.2.28.dev1
+Summary: AI-powered research, planning, and task management CLI tool
+Project-URL: Homepage, https://shotgun.sh/
+Project-URL: Repository, https://github.com/shotgun-sh/shotgun
+Project-URL: Issues, https://github.com/shotgun-sh/shotgun-alpha/issues
+Project-URL: Discord, https://discord.gg/5RmY6J2N7s
+Author-email: "Proofs.io" <hello@proofs.io>
+License: MIT
+License-File: LICENSE
+Keywords: agent,ai,cli,llm,planning,productivity,pydantic-ai,research,task-management
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Requires-Dist: aiofiles>=24.0.0
+Requires-Dist: anthropic>=0.39.0
+Requires-Dist: dependency-injector>=4.41.0
+Requires-Dist: genai-prices>=0.0.27
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: jinja2>=3.1.0
+Requires-Dist: kuzu>=0.7.0
+Requires-Dist: logfire>=2.0.0
+Requires-Dist: openai>=1.0.0
+Requires-Dist: packaging>=23.0
+Requires-Dist: posthog>=3.0.0
+Requires-Dist: pydantic-ai>=0.0.14
+Requires-Dist: pydantic-settings>=2.0.0
+Requires-Dist: pyperclip>=1.10.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: sentencepiece>=0.2.0
+Requires-Dist: sentry-sdk[pure-eval]>=2.0.0
+Requires-Dist: tenacity>=8.0.0
+Requires-Dist: textual-dev>=1.7.0
+Requires-Dist: textual-serve>=0.1.0
+Requires-Dist: textual>=6.1.0
+Requires-Dist: tiktoken>=0.7.0
+Requires-Dist: tree-sitter-go>=0.23.0
+Requires-Dist: tree-sitter-javascript>=0.23.0
+Requires-Dist: tree-sitter-python>=0.23.0
+Requires-Dist: tree-sitter-rust>=0.23.0
+Requires-Dist: tree-sitter-typescript>=0.23.0
+Requires-Dist: tree-sitter>=0.21.0
+Requires-Dist: typer>=0.12.0
+Requires-Dist: watchdog>=4.0.0
+Provides-Extra: dev
+Requires-Dist: commitizen>=3.13.0; extra == 'dev'
+Requires-Dist: lefthook>=1.12.0; extra == 'dev'
+Requires-Dist: mypy>=1.11.0; extra == 'dev'
+Requires-Dist: ruff>=0.6.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<div align="center">
+<img width="400" height="150" alt="Shotgun logo transparent background" src="https://github.com/user-attachments/assets/08f9ccd5-f2e8-4bf4-9cb2-2f0de866a76a" />  
+
+### Spec-Driven Development
+
+
+**Write codebase-aware specs for AI coding agents (Codex, Cursor, Claude Code) so they don't derail.**
+<p align="center">
+  <a href="https://github.com/shotgun-sh/shotgun">
+    <img src="https://img.shields.io/badge/python-3.11+-blue?style=flat&logo=python&logoColor=white" />
+  </a>
+  <a href="https://www.producthunt.com/products/shotgun-cli/launches/shotgun-cli">
+    <img src="https://img.shields.io/badge/Product%20Hunt-%237%20Product%20of%20the%20Day-FF6154?style=flat&logo=producthunt&logoColor=white" />
+  </a>
+  <a href="https://github.com/shotgun-sh/shotgun?tab=contributing-ov-file">
+    <img src="https://img.shields.io/badge/PRs-welcome-brightgreen?style=flat" />
+  </a>
+  <a href="https://github.com/shotgun-sh/shotgun?tab=MIT-1-ov-file">
+    <img src="https://img.shields.io/badge/license-MIT-blue?style=flat" />
+  </a>
+  <a href="https://discord.com/invite/5RmY6J2N7s">
+    <img src="https://img.shields.io/badge/discord-150+%20online-5865F2?style=flat&logo=discord&logoColor=white" />
+  </a>
+</p>
+
+[![Website](https://img.shields.io/badge/-shotgun.sh-5865F2?style=social&logo=safari&logoColor=5865F2)](https://shotgun.sh)      [![Follow @ShotgunCLI](https://img.shields.io/badge/Follow%20@ShotgunCLI-1DA1F2?style=social&logo=x&logoColor=000000)](https://x.com/ShotgunCLI)    [![YouTube](https://img.shields.io/badge/-@shotgunCLI-FF0000?style=social&logo=youtube&logoColor=red)](https://www.youtube.com/@shotgunCLI)
+
+</div>
+
+---
+
+<table>
+<tr>
+<td>
+  
+**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.
+
+<p align="center">
+  <img src="https://github.com/user-attachments/assets/9c7ca014-1ed3-4935-b310-9147b275fdc7" alt="Shotgun Demo" />
+</p>
+
+</td>
+</tr>
+</table>
+
+---
+
+# 📦 Installation
+
+### 1. Install uv
+
+Shotgun runs via `uvx` or `uv tool install`. First, install `uv` for your platform:
+
+<table>
+<tr>
+<th>Platform</th>
+<th>Installation Command</th>
+</tr>
+<tr>
+<td><strong>macOS</strong> (Homebrew)</td>
+<td>
+
+```bash
+brew install uv
+```
+</td>
+</tr>
+<tr>
+<td><strong>macOS/Linux</strong> (curl)</td>
+<td>
+
+```bash
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+</td>
+</tr>
+<tr>
+<td><strong>Windows</strong> (PowerShell)</td>
+<td>
+
+```powershell
+powershell -c "irm https://astral.sh/uv/install.ps1 | iex"       
+```
+</td>
+</tr>
+</table>
+
+_💡 Restart your terminal after installation_
+
+### 2. Run Shotgun
+
+<table>
+<tr>
+<th>🚀 Try It Out (Ephemeral)</th>
+<th>⚡ Regular Use (Permanent)</th>
+</tr>
+<tr>
+<td>
+  
+**Best for:** Testing Shotgun first
+
+```bash
+uvx shotgun-sh@latest    
+```
+
+No installation needed, runs immediately
+
+</td>
+<td>
+
+**Best for:** Daily use
+
+```bash
+uv tool install shotgun-sh       
+```
+
+Then run anywhere: ``` shotgun ```
+
+</td>
+</tr>
+</table>
+
+_**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
+
+<p align="center">
+  <a href="https://youtu.be/nR6iKbJ8l_I">
+    <img src="https://github.com/user-attachments/assets/37eae206-0d6f-4499-b980-2f33a5aed65d" alt="Watch the Shotgun demo" width="720" height="405">
+  </a>
+</p>
+
+_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
+
+<table>
+<tr>
+<td align="center"><b>🔬 Research</b><br/>Explore & understand</td>
+<td align="center">→</td>
+<td align="center"><b>📝 Specify</b><br/>Define requirements</td>
+<td align="center">→</td>
+<td align="center"><b>📋 Plan</b><br/>Create roadmap</td>
+<td align="center">→</td>
+<td align="center"><b>✅ Tasks</b><br/>Break into steps</td>
+<td align="center">→</td>
+<td align="center"><b>📤 Export</b><br/>Format for AI</td>
+</tr>
+</table>
+
+_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 |
+|:-----|:-------------|:---------------|:-------|
+| **🔬&nbsp;Research** | Searches codebase + web, identifies patterns | `How do we handle authentication in this codebase?` | `research.md` |
+| **📝&nbsp;Specify** | Creates technical specs aware of architecture | `Add OAuth2 authentication with refresh token support` | `specification.md` |
+| **📋&nbsp;Plan** | Generates implementation roadmap | `Create an implementation plan for the payment system` | `plan.md` |
+| **✅&nbsp;Tasks** | Breaks plans into actionable items | `Break down the user dashboard plan into tasks` | `tasks.md` |
+| **📤&nbsp;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
+
+<table>
+<tr>
+<th width="25%">Feature</th>
+<th width="35%">Shotgun</th>
+<th width="40%">Other Tools</th>
+</tr>
+
+<tr>
+<td><strong>Codebase Understanding</strong></td>
+<td>
+Reads your <strong>entire repository</strong> before generating specs. Finds existing patterns, dependencies, and architecture.
+</td>
+<td>
+Require manual context or search each time. No persistent understanding of your codebase structure.
+</td>
+</tr>
+
+<tr>
+<td><strong>Research Phase</strong></td>
+<td>
+Starts with research—discovers what you already have AND what exists externally before writing anything.
+</td>
+<td>
+Start at specification. Build first, discover problems later.
+</td>
+</tr>
+
+<tr>
+<td><strong>Dedicated Agents Per Mode</strong></td>
+<td>
+Each mode (research, spec, plan, tasks, export) uses a <strong>separate specialized agent</strong> with prompts tailored specifically for that phase. 100% user-controllable via mode switching.
+</td>
+<td>
+Single-agent or one-size-fits-all prompts.
+</td>
+</tr>
+
+<tr>
+<td><strong>Structured Workflow</strong></td>
+<td>
+5-phase journey with checkpoints: Research → Spec → Plan → Tasks → Export
+</td>
+<td>
+No structure. Just "prompt and hope."
+</td>
+</tr>
+
+<tr>
+<td><strong>Export Formats</strong></td>
+<td>
+<code>AGENTS.md</code> files ready for Cursor, Claude Code, Windsurf, Lovable—your choice of tool.
+</td>
+<td>
+Locked into specific IDE or coding agent.
+</td>
+</tr>
+
+</table>
+
+### 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.
+
+![Indexing Privacy](docs/index_codebase_privacy.png)
+
+**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!
+
+<div align="left">
+  <a href="https://discord.com/invite/5RmY6J2N7s">
+    <img src="https://img.shields.io/badge/Join%20our%20community-5865F2?style=for-the-badge&logo=discord&logoColor=white" alt="Join Discord" />
+  </a>
+</div>
+
+### 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
+
+---
+
+<div align="center">
+
+## 🚀 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
+
+
+<a href="https://github.com/shotgun-sh/shotgun">
+  <img src="https://img.shields.io/badge/⭐%20Star%20on%20GitHub-181717?style=for-the-badge&logo=github&logoColor=white" alt="Star Shotgun Repo" />
+</a>
+
+### Star History
+
+<a href="https://www.star-history.com/#shotgun-sh/shotgun&type=date&legend=bottom-right">
+ <picture>
+   <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=shotgun-sh/shotgun&type=date&theme=dark&legend=bottom-right" />
+   <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=shotgun-sh/shotgun&type=date&legend=bottom-right" />
+   <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=shotgun-sh/shotgun&type=date&legend=bottom-right" />
+ </picture>
+</a>
+
+</div>
+
+---
+
+**License:** MIT | **Python:** 3.11+ | **Homepage:** [shotgun.sh](https://shotgun.sh/)
+
+---
+
+## Uninstall
+
+```bash
+uv tool uninstall shotgun-sh
+```