SpecSync Documentation

Welcome to the SpecSync documentation site. SpecSync keeps Markdown specifications in sync between your repository and an external workspace so the information that guides development stays close to the code.

Quick Start

1. Install SpecSync with pipx install specsync or uv tool install specsync

2. Set your workspace location: export SPECSYNC_WORKSPACE_ROOT="/path/to/workspace"

3. Run specsync init inside your repository to scaffold the specs/ directory

4. Create or edit specs in your repo’s specs/ folder

5. Use specsync push to sync specs to your workspace for long-term storage

Note

The command-line reference in Usage includes additional options and recommended workflows for day-to-day use.

Contents

Guides

• Installation
  • Prerequisites
  • Install with pipx
  • Install with uv
  • Install from Source
  • Development Setup
• Usage
  • Basic Commands
  • Command-line Options
  • Common Workflows
  • Setting Environment Variables
• Configuration
  • Configuration Hierarchy
  • Environment Variables
  • Project Configuration (pyproject.toml)
  • Setting Environment Variables
  • Frontmatter Format
• Architecture
  • System Design
  • Component Overview
  • Data Flow
  • File Sync Algorithm
  • Frontmatter Filtering Logic
• Changelog
  • [Unreleased]
• API Reference
  • Module Overview
  • Command-Line Interface
  • Configuration API
  • Future Development

Additional Resources

• Source code: https://github.com/username/specsync

• Architecture Overview - detailed system design and component documentation