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.dev6.tar.gz (225.7 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.dev6-py3-none-any.whl (310.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: shotgun_sh-0.2.11.dev6.tar.gz
  • Upload date:
  • Size: 225.7 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.dev6.tar.gz
Algorithm Hash digest
SHA256 d9ecf53a3457ae67df1c6212eb1bebb43453fcd94e1becdbfa401a9e783754d9
MD5 e88ba8fbcb4da6881e776415a81ab01b
BLAKE2b-256 0c2ca8488647f93d71458873bc009bca3cdff584ce2ef7260eaea4a66dbd3251

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for shotgun_sh-0.2.11.dev6-py3-none-any.whl
Algorithm Hash digest
SHA256 4ec408682776a0cbbe56af36f43782a6b0a28ac998cf0c0563975f37cd9c0ceb
MD5 fdeee1a6698299a3c2ff34946abb9acd
BLAKE2b-256 df2b9f18c08cdbef45fb33df25546f5cf9ae68cf5fbe82357b663b299c4cc079

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