Commands Reference 📖

Complete CLI reference for pave.

pave init

Initialize pave in your project.

pave init

What it does:

• Creates .pave.toml config file
• Sets up default docs/ directory
• Configures sensible defaults for rules

pave new

Scaffold a new document from templates.

pave new <type> <name>

Arguments:

Examples:

# Create a component doc
pave new component auth-service

# Create a runbook
pave new runbook deploy-production

# Create an ADR
pave new adr use-rust-for-cli

Output locations:

• Components: docs/components/<name>.md
• Runbooks: docs/runbooks/<name>.md
• ADRs: docs/adrs/<name>.md

pave prompt

Generate AI agent prompts for documentation tasks.

pave prompt <type> [options]

Arguments:

Options:

Examples:

# Generate a prompt for creating docs
pave prompt create

# Generate with context
pave prompt update --context src/auth.rs

# JSON output for programmatic use
pave prompt create --json

pave index

Generate a documentation index.

pave index [options]

Options:

Examples:

# Generate index with defaults
pave index

# Custom output location
pave index --output docs/README.md

# Update existing index, keeping custom notes
pave index --update

What it does:

• Scans docs/ directory recursively
• Extracts titles and purpose summaries
• Categorizes by document type
• Generates Quick Links and sections
• Preserves custom content between markers

pave check

Validate documentation against rules.

pave check [path]

Arguments:

Rules enforced:

• max_lines: Maximum lines per document (default: 300)
• require_verification: Must have Verification section
• require_examples: Must have Examples section

Examples:

# Check all docs
pave check

# Check specific file
pave check docs/components/auth.md

pave config

Manage pave configuration.

pave config <subcommand>

Subcommands:

Examples:

# View all config
pave config list

# Get a specific value
pave config get rules.max_lines

# Set a value
pave config set rules.max_lines 500

# Find config file
pave config path

Config keys: