Skip to main content

AI-powered research, planning, and task management CLI tool

Project description

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

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):

uvx shotgun-sh

Install permanently:

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 or curl -LsSf https://astral.sh/uv/install.sh | sh

Using pipx

pipx install shotgun-sh

If you encounter build errors with kuzu on macOS:

pipx install --pip-args="--only-binary kuzu" shotgun-sh

Using pip

pip install shotgun-sh

Quick Start

# 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


License: MIT Python: 3.11+

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shotgun_sh-0.2.10.dev10.tar.gz (189.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

shotgun_sh-0.2.10.dev10-py3-none-any.whl (257.6 kB view details)

Uploaded Python 3

File details

Details for the file shotgun_sh-0.2.10.dev10.tar.gz.

File metadata

  • Download URL: shotgun_sh-0.2.10.dev10.tar.gz
  • Upload date:
  • Size: 189.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for shotgun_sh-0.2.10.dev10.tar.gz
Algorithm Hash digest
SHA256 c594211130d752adc316fcde1b71c2468a0982ad47bff10bc7ec61df3aacbe0f
MD5 5fde65bb174035ae18e351940172ac14
BLAKE2b-256 16e75d2236946e66a3415cf554c3d326f87da1d5f4198bc0a7144aefe2e37528

See more details on using hashes here.

File details

Details for the file shotgun_sh-0.2.10.dev10-py3-none-any.whl.

File metadata

File hashes

Hashes for shotgun_sh-0.2.10.dev10-py3-none-any.whl
Algorithm Hash digest
SHA256 af39b6f7e1ec52f141f29738d8e2a5f29f7ce4a5012b443a7c2d377e3df6e6eb
MD5 cd1761f0c97ef1700f60497e8b9ef58a
BLAKE2b-256 298e843fa9e43dc860b42dd09286f42f2516f84e83b1d1c0727e8d3c82a3d9cc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page