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 specificationspec-driver-spec-list- List specificationsspec-driver-requirement- Manage requirementsspec-driver-revision- Create revision blocksspec-driver-validate-workspace- Validate workspace consistency
Project Integration
spec-driver is designed to be integrated into projects using:
- Directory structure:
specify/andchange/directories for artifacts - Justfile module: Integration with project build tools
- 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
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file spec_driver-0.2.0.tar.gz.
File metadata
- Download URL: spec_driver-0.2.0.tar.gz
- Upload date:
- Size: 180.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.8.23
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1b75ec42f1249bcbbe1cc8e110c0013bf6a3293e9206da461a2f1a6aecf09204
|
|
| MD5 |
847491f8d20d1dfb8793b7fe5070f15b
|
|
| BLAKE2b-256 |
5a273c1aa6d10406827fa1f4796b2d2e59ea863df161af344b52be17c5c11fa6
|
File details
Details for the file spec_driver-0.2.0-py3-none-any.whl.
File metadata
- Download URL: spec_driver-0.2.0-py3-none-any.whl
- Upload date:
- Size: 229.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.8.23
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2d3dee17f5afa83e7d354bc0618cd957df8f158cce7057b7edf150fa8b606d96
|
|
| MD5 |
3707c7d9b507fdf5eea92a7ec6b93fc4
|
|
| BLAKE2b-256 |
3d4738f4fa7872978fa72d288a0cd58dc2c16244bb1e6b93bd53f7a80bcba709
|