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.dev5.tar.gz (226.1 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.dev5-py3-none-any.whl (309.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: shotgun_sh-0.2.11.dev5.tar.gz
  • Upload date:
  • Size: 226.1 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.dev5.tar.gz
Algorithm Hash digest
SHA256 2c5a0ecf2359249be78c5deddf4ff1e53424c858ced4bdf4e81a02ed8b8bdf2e
MD5 89596b25611a7f0fa71dc8c7a3781e36
BLAKE2b-256 be9440c093eda4c5c1dd0ea57f6a29e1862c27d813839e93651659643d400e82

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for shotgun_sh-0.2.11.dev5-py3-none-any.whl
Algorithm Hash digest
SHA256 8fc44c1a556ae95b7cc36398d2c70eeb8b74d1008847d69b8419888c47ce9ff5
MD5 5f4849aa9cb1d9d73ce347659a19af24
BLAKE2b-256 0091cde1c2e337fc3aa363de03d766d138719d75610acde9b7ec00108f18fc84

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