LineSpec Documentation
Complete guides and references for using LineSpec to manage architectural decisions and integration testing.
Provenance Records
Structured YAML artifacts that capture architectural decisions, intent, constraints, and scope.
Read documentation →Schema Reference
Complete field definitions, types, and validation rules for Provenance Records.
View schema →LineSpec Testing Beta
DSL-based integration testing framework for containerized services.
Learn the DSL →What is LineSpec?
LineSpec is a tool for managing Provenance Records — structured decision documents that capture the intent, constraints, and reasoning behind architectural changes. It includes a powerful CLI for creating, validating, and enforcing these records.
The default installation includes only the stable Provenance Records functionality. LineSpec Testing features are available as a beta opt-in.
| Feature | Status | Installation |
|---|---|---|
| Provenance Records | Stable | brew install linespec |
| LineSpec Testing | Beta | brew install linespec-beta |
Documentation Structure
Provenance Records
- Introduction - What are Provenance Records?
- Quick Start - Get up and running
- Core Concepts - ID format, status lifecycle
- Schema Reference - Complete field reference
- CLI Commands - All available commands
- Configuration - .linespec.yml options
- Git Integration - Hooks and validation
- Examples - Real-world examples
Schema Reference
- Field Summary - All fields at a glance
- Required Fields - id, title, status, etc.
- Optional Fields - constraints, scope, tags
- Validation Rules - Lint rules and enforcement
LineSpec Testing Beta
- Introduction - DSL overview
- Grammar - Statement structure
- EXPECT - Dependencies
- VERIFY - SQL validation
- Examples - Complete test specs