Documentation

spec-sync docs

Bidirectional spec-to-code validation. Written in Rust, single binary, 12 languages. Everything from a 5-minute quickstart to the full CLI surface, configuration, and CI integrations.

5-min quickstart → CLI reference Examples

Getting started

Why spec-sync?

How spec-sync compares to other documentation validation approaches.

Quickstart

Get spec-sync running on your project in under 5 minutes.

Spec format

How to write *.spec.md files: frontmatter, required sections, Public API tables.

Reference

CLI reference

Every spec-sync command, flag, exit code, and JSON output shape.

Configuration

All .specsync/config.toml options: sources, schema, AI providers, rules.

Workflow guide

The full spec lifecycle: create, validate, iterate, stabilize, maintain, archive.

Cross-project references

Validate spec dependencies across repositories with the owner/repo@module syntax.

Architecture

How spec-sync is built: source layout, validation pipeline, adding a language.

Integrations

VS Code extension

Real-time spec validation, quality scores, and coverage reports inside VS Code.

GitHub Action

Run spec-sync in CI with zero setup. Auto-detects OS/arch, downloads the binary.

For AI agents

MCP server, AI generation, and machine-readable specs for LLM-powered tools.

Examples

All examples →

Worked, end-to-end walkthroughs.

Rust workspace

Sync a Rust workspace end-to-end

From spec-sync check to a tagged release, with cross-crate references.

8 steps · ~12 min

Polyglot

Multi-language repo: TS + Python + Rust

One spec format, three languages, one CI gate.

7 steps · ~10 min

CI / CD

CI gate with the GitHub Action

Block merges when specs drift from code.

5 steps · ~7 min