Skip to main content

AI-assisted software project planning — from idea to executable coding phases

Project description

Spec4 AI

AI-assisted software project planning — from idea to executable coding phases.

PyPI version

Spec4 is a Dash app (using Dash Mantine Components) that guides you from idea to deployment using a pipeline of specialised LLM agents. Start with a rough idea and finish with a set of structured, ordered development phases — plus an optional UI mock and deployment plan — ready to hand to an AI coding agent like Claude Code.

"You've made something really really really cool. I'm almost done with our driver app. Will be field tested by Friday. I don't think I would have built what this is going to become without it."
Wihan Booyse, Kriterion.ai

How It Works

How Spec4 Works


Requirements

  • Python 3.12+
  • uv package manager
  • An API key for at least one supported LLM provider
  • (Optional) A Tavily API key for web search

Installation

Option 1 — Install from PyPI (recommended for most users):

uv tool install spec4 --refresh
spec4

Option 2 — Run from source (for contributors and developers):

git clone https://github.com/robertcrowe/spec4
cd spec4
make spec4

make spec4 runs uv sync (creates a .venv and installs all dependencies) then launches the app. All packages stay inside .venv — nothing is installed into your global Python.

Subsequent runs: make run reuses the existing .venv.

The app will be available at http://localhost:8050 in both cases.


Features

  • Six-stage pipeline — CodeScanner (optional) → Brainstormer → Designer → StackAdvisor → Phaser → Deployer
  • Designer — optional parallel stage that generates an HTML mock of your UI from a vision and (optionally) reference screenshots
  • Any LLM provider — works with OpenAI, Anthropic, Google Gemini, Cohere, and Mistral via LiteLLM
  • Web search grounding — all agents can search the web via Tavily to find canonical documentation
  • Saved credentials — optionally remember your provider, model, and API keys in the browser (localStorage via dcc.Store — never sent to or stored on the server)
  • Incremental output — each agent produces a downloadable artifact you can reuse in a later session
  • Jump-in anywhere — pick up at any stage by selecting a project directory with previously saved artifacts
  • Project persistence — artifacts saved to a .spec4/ folder inside your chosen project directory
  • Deployer — Generates a deployment plan including coding agent instructions and even Terraform scripts

Agents

🔍 CodeScanner (optional)

Analyzes an existing project directory to understand its architecture, technology stack, and coding style. Results inform Brainstormer and StackAdvisor when working on brownfield projects. Produces code_review.json.

🧠 Brainstormer

Develops a clear project vision through focused, one-at-a-time questions. Identifies technical standards via web search and embeds canonical documentation links in the output. Produces vision.json.

🎨 Designer (optional, parallel)

Generates a single-file HTML mock of your UI from your vision and reference screenshots. Supports two modes — create from scratch, or modify an existing UI while preserving its look and feel — with iterative refinement. Skipped automatically for CLI/terminal projects. Produces design/mock.html. Sample Design Mock

⚙️ StackAdvisor

Recommends languages, frameworks, hosting, and infrastructure based on the vision. Compares options, explains trade-offs, and uses web search to ground every recommendation. Produces stack.json.

📋 Phaser

Decomposes the vision and stack into an ordered sequence of development phases:

  • Phase 1 is always a steel thread — a minimal end-to-end path that validates the core architecture
  • Each phase builds on the previous one
  • Stack spec fidelity — confirms before adding any dependency not in the stack spec
  • Verification criteria — every phase includes the exact command needed to confirm it succeeded

Saves one JSON file per phase under .spec4/phases/, downloadable as phases.zip.

🚀 Deployer

Plans the path from working code to a running production deployment. Walks through coding-agent workflow, deployment target, containerization, CI/CD, environment config, and monitoring — and can optionally generate complete Terraform scripts grounded in live provider docs via web search. Produces deployment-plan.md. Sample Deployment Plan


Usage

  1. Select a project directory — new or existing; artifacts are saved to .spec4/ inside it.
  2. Connect — select a provider, enter your API key, and choose a model. Optionally add a Tavily key for web search.
  3. Choose a starting point — pick an agent to begin with.
  4. Plan — chat with each agent. When an agent completes, download the result and continue to the next agent.

Picking up where you left off

Each session auto-saves to .spec4/ inside your project directory. On a future visit, select the same directory and previously completed artifacts will be loaded automatically.


Project structure

src/spec4/
├── app.py                  # Dash entry point — app wiring, root layout, page render
├── app_constants.py        # Phase names, URL→phase routing, agent state constants
├── session.py              # Session defaults, agent runner, artifact persistence
├── streaming.py            # Background-thread streaming + provider error formatting
├── providers.py            # Provider/model registry, live model fetching
├── tavily_mcp.py           # Tavily web search integration (async bridge)
├── project_manager.py      # .spec4/ artifact persistence
├── agents/
│   ├── code_scanner.py     # Code review agent
│   ├── brainstormer.py     # Vision development agent
│   ├── stack_advisor.py    # Technology stack recommendation agent
│   ├── phaser.py           # Incremental phase planning agent
│   ├── deployer.py         # Deployment planning agent (terminal pipeline stage)
│   └── designer.py         # UI mock generation agent (parallel, optional)
├── callbacks/              # Dash server-side callbacks (main pipeline + designer)
└── layouts/                # Page layout functions (chat, setup, designer, shared)
tests/                      # pytest test suite
Makefile                    # Common commands

Development

make spec4       # First-time setup: create .venv, install deps, and launch
make install     # Create .venv and install all dependencies (uv sync)
make run         # Start the app (http://localhost:8050)
make dev         # Start with debug/hot-reload enabled
make test        # Run tests
make lint        # Lint check with ruff
make serve       # Production server via gunicorn (requires: uv add gunicorn)

# Add a dependency (always use uv so it stays in .venv)
uv add <package>
uv add --dev <package>

Supported providers

Provider Models fetched from
OpenAI api.openai.com/v1/models
Anthropic api.anthropic.com/v1/models
Google Gemini generativelanguage.googleapis.com
Cohere api.cohere.com/v2/models
Mistral api.mistral.ai/v1/models

Models are fetched live from each provider's API when you connect, with a hardcoded fallback list if the API is unavailable.


License

Apache 2.0 — see LICENSE for details.

Project details


Download files

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

Source Distribution

spec4-0.6.2.tar.gz (180.7 kB view details)

Uploaded Source

Built Distribution

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

spec4-0.6.2-py3-none-any.whl (196.1 kB view details)

Uploaded Python 3

File details

Details for the file spec4-0.6.2.tar.gz.

File metadata

  • Download URL: spec4-0.6.2.tar.gz
  • Upload date:
  • Size: 180.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.0 {"installer":{"name":"uv","version":"0.10.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for spec4-0.6.2.tar.gz
Algorithm Hash digest
SHA256 40d351099d0fd850d1b4be625aa97091634dd205fda986d281525b584a0a9bdc
MD5 1740d3292b82478e9071f58b5d72cb74
BLAKE2b-256 818e3d89543ffe8b011d9391a4c1f95c35933d59c4a0067cabf83fcfed58fa02

See more details on using hashes here.

File details

Details for the file spec4-0.6.2-py3-none-any.whl.

File metadata

  • Download URL: spec4-0.6.2-py3-none-any.whl
  • Upload date:
  • Size: 196.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.0 {"installer":{"name":"uv","version":"0.10.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for spec4-0.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 dbc27b887101bf9e942e300d3fe99e90e03f4f04469006b6392158adf07a43d1
MD5 7554a991aa7fac4b7fc5886e54903b1c
BLAKE2b-256 d45f5b8d362b0c9dc5047ba711ff18040c14688d3a648794eaba084e266ef2ca

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