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@latest

Install permanently:

uv tool install shotgun-sh

If you don't have uv installed, get it at astral.sh/uv or curl -LsSf https://astral.sh/uv/install.sh | 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.11.dev1.tar.gz (216.3 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.11.dev1-py3-none-any.whl (298.6 kB view details)

Uploaded Python 3

File details

Details for the file shotgun_sh-0.2.11.dev1.tar.gz.

File metadata

  • Download URL: shotgun_sh-0.2.11.dev1.tar.gz
  • Upload date:
  • Size: 216.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for shotgun_sh-0.2.11.dev1.tar.gz
Algorithm Hash digest
SHA256 d2663d03a257e314bd8f2e0bf76bf516c18d9a9196d9bb583eb67f1464d85d81
MD5 ac18df01b15905dca2b07dcef054e5cb
BLAKE2b-256 8d63bd1b029fd69c030d37b86508eb48486d5d3e9598003cae6179f91d87a767

See more details on using hashes here.

File details

Details for the file shotgun_sh-0.2.11.dev1-py3-none-any.whl.

File metadata

File hashes

Hashes for shotgun_sh-0.2.11.dev1-py3-none-any.whl
Algorithm Hash digest
SHA256 18950e5bda965228827109c620cdad285b7e1de9e856b62cb98166d66ba475db
MD5 19d0d999fc7e9206cc94929762aa77b7
BLAKE2b-256 6a4fd8822346debc4648907d6fac9cf196a4eaa37b63b950be8751e4cdc1174b

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