Documentation

sync-tools Documentation

Welcome to the sync-tools documentation! Here you’ll find comprehensive guides and documentation to help you get started with sync-tools.

What is sync-tools?

sync-tools is a powerful, modern Go CLI wrapper around rsync that provides:

  • Fast & Efficient: Built with Go for high performance and cross-platform support
  • Advanced Sync Modes: One-way or two-way directory synchronization
  • Git Patch Integration: Generate, preview, and apply git patches
  • Interactive Preview: Colored diff preview with paging support
  • Declarative Configuration: SyncFile format for complex workflows
  • Flexible Filtering: Gitignore-style patterns and whitelist modes

Quick Navigation

Getting Started

Learn how to install and use sync-tools with basic examples. [Get Started →](/sync-tools/docs/getting-started/)

SyncFile Format

Master the powerful SyncFile format for declarative sync operations. [Learn SyncFile →](/sync-tools/docs/syncfile/)

Git Patch Features

Discover patch generation, preview, and application workflows. [Patch Guide →](/sync-tools/docs/patches/)

Examples

Check out our examples section for real-world usage scenarios and recipes.

Getting Started

Install and use sync-tools with basic examples.

SyncFile Format

Master the powerful SyncFile format for declarative sync operations.

Git Patch Features

Discover patch generation, preview, and application workflows.

Examples

Real-world usage scenarios and recipes for sync-tools.

Development Guide

Advanced development patterns and architecture in sync-tools v0.4.0