🛣️ pave

A CLI tool for creating, validating, and managing documentation optimized for human+agent pairs.

What is PAVED?

PAVED is a documentation framework that treats docs like APIs:

• Purpose - What is this? What problem does it solve?
• API/Interface - How do you use it?
• Verification - How do you know it's working?
• Examples - Concrete, copy-paste usage
• Decisions - Why this design? What must not change?

Quick Start

# Build from source
cargo build --release

# Initialize in your project
pave init

# Create a new document
pave new component my-service

# Validate your docs
pave check

# Run verification commands
pave verify

# Generate index
pave index

Commands

Command	Description
pave init	Initialize pave in your project
pave new <type> <name>	Scaffold a new document
pave check	Validate documents against rules
pave verify	Run verification commands from docs
pave changed	Show docs impacted by code changes
pave index	Generate documentation index
pave prompt <type>	Generate AI agent prompts
pave config	Manage configuration

Document Types

• Components - For services, libraries, and modules
• Runbooks - For operational procedures
• ADRs - Architecture Decision Records

Learn More

• Documentation
• Manifesto
• Getting Started