Metadata-Version: 2.4
Name: equa-spec
Version: 0.7.0
Summary: Specify CLI, part of GitHub Spec Kit. A tool to bootstrap your projects for Spec-Driven Development (SDD).
License: MIT
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Code Generators
Classifier: Topic :: Software Development :: Quality Assurance
Requires-Python: >=3.11
Requires-Dist: click>=8.1
Requires-Dist: httpx[socks]
Requires-Dist: packaging>=23.0
Requires-Dist: platformdirs
Requires-Dist: pyyaml>=6.0
Requires-Dist: readchar
Requires-Dist: rich
Requires-Dist: truststore>=0.10.4
Requires-Dist: typer
Provides-Extra: mcp
Requires-Dist: fastmcp>=1.0.0; extra == 'mcp'
Requires-Dist: gitpython>=3.1.0; extra == 'mcp'
Requires-Dist: pydantic>=2.0.0; extra == 'mcp'
Provides-Extra: test
Requires-Dist: pytest-cov>=4.0; extra == 'test'
Requires-Dist: pytest>=7.0; extra == 'test'
Description-Content-Type: text/markdown

# Spec Kit

**A CLI and template system for Specification-Driven Development (SDD)**

Bootstrap projects with structured specifications, implementation plans, and task breakdowns that AI coding agents can execute.

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
[![Cross-Platform](https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux-lightgrey)](#)

---

## What is Spec Kit?

Spec Kit provides a methodology and toolchain where **specifications drive implementation**, not the other way around. Instead of writing code and documenting after the fact, you define what you want in structured specs, and AI agents generate implementation from those specs.

The core workflow:

1. **`/speckit.constitution`** — Define project principles and architectural constraints *(once per project)*
2. **`/speckit.specify`** — Describe a feature in natural language, get a structured specification
3. **`/speckit.plan`** — Generate a technical implementation plan from the spec
4. **`/speckit.tasks`** — Break the plan into dependency-ordered, executable tasks
5. **`/speckit.implement`** — Execute the task list

See the [pipeline diagram](docs/pipeline.md) for all 10 steps including optional quality gates (`/speckit.clarify`, `/speckit.analyze`, `/speckit.test`).

## Key Features

- **Template System** — Structured templates for specs, plans, tasks, checklists, and project constitutions
- **Multi-Agent Support** — Works with Claude Code, GitHub Copilot, Gemini CLI, Cursor, Codex, Windsurf, and 12+ other AI agents
- **Domain Analysis** — Extract business entities, rules, and integration patterns from JSON/CSV data files
- **Extension System** — Plugin architecture with manifest schema, official + community catalogs
- **Cross-Platform** — Every automation script has both Bash and PowerShell variants
- **MCP Server** — Expose spec-kit tools via the Model Context Protocol

## Quick Start

### Prerequisites

- Git
- Access to `EQUAStart/spec-kit-template` (org member)
- An AI coding agent (Claude Code, Copilot, Gemini CLI, etc.)

### Connect a Project (Recommended)

```bash
# From your project root — adds .speckit/ submodule + creates symlinks
/path/to/spec-kit-template/scripts/bash/speckit-bootstrap.sh

# Or with explicit remote
speckit-bootstrap.sh --remote https://github.com/EQUAStart/spec-kit-template.git
```

This adds the toolkit as a submodule and creates symlinks. **Your toolkit auto-syncs** with upstream on every `/speckit.*` command — no manual updates needed. See the [installation guide](docs/installation.md) to compare install methods.

## Project Structure

```
spec-kit-main/
├── src/
│   ├── specify_cli/           # CLI application (Typer + Rich)
│   └── speckit_mcp/           # MCP server (FastMCP)
├── templates/                 # Master SDD templates
│   ├── spec-template.md       # Feature specification
│   ├── plan-template.md       # Implementation plan
│   ├── tasks-template.md      # Task breakdown
│   ├── checklist-template.md  # Quality checklist
│   ├── constitution-template.md # Project constitution
│   └── commands/              # AI agent slash commands
├── extensions/                # Extension system + catalogs
├── scripts/                   # Bash + PowerShell automation
├── sample-data/               # Example datasets (financial, ecommerce, CRM)
├── tests/                     # Pytest test suite
└── docs/                      # Documentation (DocFX)
```

## The SDD Methodology

Spec Kit implements Specification-Driven Development — a methodology where specifications are the primary artifact and code is the generated output. See [spec-driven.md](spec-driven.md) for the full philosophy.

Core principles:
- **Specifications as the source of truth** — code serves specifications, not the other way around
- **Executable specifications** — precise enough to generate working systems
- **Constitutional governance** — immutable architectural principles (Articles I-IX) enforced through template gates
- **Test-first thinking** — test scenarios are part of the specification, not an afterthought

## Documentation

- [Quick Start Guide](docs/quickstart.md) — Step-by-step SDD workflow
- [Installation](docs/installation.md) — Connecting to the shared toolkit
- [Adding to an Existing Project](docs/existing-project.md) — Bootstrapping, overrides, CI/CD
- [Upgrading & Syncing](docs/upgrade.md) — Auto-sync, pinning, troubleshooting
- [Local Development](docs/local-development.md) — Contributing and iterating locally
- [Domain Analysis Usage](extensions/specify-mcp/USAGE.md) — Automated entity extraction from data files
- [Extension Development](extensions/EXTENSION-DEVELOPMENT-GUIDE.md) — Building spec-kit extensions

## License

This project is licensed under the MIT License — see [LICENSE](LICENSE) for details.
