Skip to main content

Specification-driven development toolkit with multi-language spec sync and documentation generation

Project description

spec-driver

Specification-driven agentic development toolkit with multi-language spec sync and documentation generation.

Why?

  • Maintain verifiably accurate, evergreen specs covering your entire system
  • Use cheap, fast, deterministically generated docs to complement and audit the work of messy, stochastic agents
  • The combination of markdown and YAML is a surprisingly powerful platform for structured, legible data
  • Tooling joins related entities through a registry for fast lookup, validation, and relational data propagation
  • Stop banging rocks together

Status

Alpha - Under active development. API and CLI may change.

Features

  • Multi-language spec sync: Automatically sync specifications with Go and Python codebases
  • Architecture Decision Records (ADRs): Manage and track architectural decisions
  • Delta/Change tracking: Track and manage specification changes and revisions
  • Documentation generation: Generate documentation from code using AST analysis
  • Workspace validation: Ensure consistency across specification artifacts

Installation

From GitHub (Development)

# Install from latest commit
uv add git+https://github.com/davidlee/spec-driver

# Or use with uvx (no installation)
uvx --from git+https://github.com/davidlee/spec-driver spec-driver-sync --help

From PyPI (Future)

uv add spec-driver

Usage

spec-driver provides multiple CLI commands:

Specification Sync

# Sync specifications with codebase
spec-driver-sync

# Dry run to see what would be synced
spec-driver-sync --dry-run

# Sync specific language
spec-driver-sync --language python

Architecture Decision Records

# Create new ADR
spec-driver-adr new "Use event sourcing for audit trail"

# List ADRs
spec-driver-adr list

# Show ADR details
spec-driver-adr show ADR-001

Deltas and Changes

# Create delta
spec-driver-delta

# List deltas
spec-driver-delta-list

# Complete delta
spec-driver-delta-complete DELTA-001

Other Commands

  • spec-driver-spec - Create new specification
  • spec-driver-spec-list - List specifications
  • spec-driver-requirement - Manage requirements
  • spec-driver-revision - Create revision blocks
  • spec-driver-validate-workspace - Validate workspace consistency

Project Integration

spec-driver is designed to be integrated into projects using:

  1. Directory structure: specify/ and change/ directories for artifacts
  2. Justfile module: Integration with project build tools
  3. Agent instructions: Claude Code integration via agent files

Installation script (future):

uvx spec-driver install

Development

This package is under active development and API stability is not yet guaranteed.

Current development happens in the vice repository.

License

MIT

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

spec_driver-0.1.0.tar.gz (154.5 kB view details)

Uploaded Source

Built Distribution

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

spec_driver-0.1.0-py3-none-any.whl (217.1 kB view details)

Uploaded Python 3

File details

Details for the file spec_driver-0.1.0.tar.gz.

File metadata

  • Download URL: spec_driver-0.1.0.tar.gz
  • Upload date:
  • Size: 154.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.23

File hashes

Hashes for spec_driver-0.1.0.tar.gz
Algorithm Hash digest
SHA256 3989e70343396c8e52c758649452186600e89184a7edf313c41de922c1567b12
MD5 a5a8b6b4878b7c252204e15687f2dfc0
BLAKE2b-256 8f80f715fe3583c2b0cb138e37ad0a9b94f0309b81214a17c07f548c3ec17925

See more details on using hashes here.

File details

Details for the file spec_driver-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for spec_driver-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9029d56bf839af7fa4f7467ad06776c40bcfdc33af8ef76cd61c4c79b610a2b3
MD5 ad236366c2d4aa1934df8d473eddc369
BLAKE2b-256 ed88c298f0a7ab7bc7f04bdd48015d078db80c8d3ad677ac9cbaa6ac3481e1e0

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