Metadata-Version: 2.4
Name: shotgun-sh
Version: 0.2.10.dev9
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 :: 3 - Alpha
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: anthropic>=0.39.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: 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

# Shotgun

**Spec-Driven Development for AI Code Generation**

Shotgun is a CLI tool that turns work with AI code-gen tools from "I want to build X" into: **research → specs → plans → tasks → implementation**. It reads your entire codebase, coordinates AI agents to do the heavy lifting, and exports clean artifacts in the agents.md format so your code-gen tools actually know what they're building.

🌐 **Learn more at [shotgun.sh](https://shotgun.sh/)**

## Features

### 📊 Complete Codebase Understanding

Before writing a single line, Shotgun reads all of it. Your patterns. Your dependencies. Your technical debt. Whether you're adding features, onboarding devs, planning migrations, or refactoring - Shotgun knows what you're working with.

### 🔄 Five Modes. One Journey. Zero Gaps.

**Research** (what exists) → **Specify** (what to build) → **Plan** (how to build) → **Tasks** (break it down) → **Export** (to any tool)

Not another chatbot. A complete workflow where each mode feeds the next.

### ➡️ Export to agents.md

Outputs plug into many code-generation tools including Codex, Cursor, Warp, Devin, opencode, Jules, and more.

### 📝 Specs That Don't Die in Slack

Every research finding, every architectural decision, every "here's why we didn't use that library" - captured as markdown in your repo. Version controlled. Searchable.

## Installation

### Using uvx (Recommended)

**Quick start (ephemeral):**
```bash
uvx shotgun-sh
```

**Install permanently:**
```bash
uv tool install shotgun-sh
```

**Why uvx?** It's 10-100x faster than pipx and handles binary wheels more reliably. If you don't have `uv` installed, get it at [astral.sh/uv](https://astral.sh/uv) or `curl -LsSf https://astral.sh/uv/install.sh | sh`

### Using pipx

```bash
pipx install shotgun-sh
```

If you encounter build errors with kuzu on macOS:
```bash
pipx install --pip-args="--only-binary kuzu" shotgun-sh
```

### Using pip

```bash
pip install shotgun-sh
```

## Quick Start

```bash
# Research your codebase or a topic
shotgun research "What is our authentication flow?"

# Generate specifications
shotgun spec "Add OAuth2 authentication"

# Create an implementation plan
shotgun plan "Build user dashboard"

# Break down into tasks
shotgun tasks "Implement payment system"

# Export to agents.md format for your code-gen tools
shotgun export
```

## Support

Have questions? Join our community on **[Discord](https://discord.gg/5RmY6J2N7s)**

---

**License:** MIT
**Python:** 3.11+
