Skip to content

README.md

Latest commit

 

History

History
53 lines (40 loc) · 1.57 KB

README.md

File metadata and controls

53 lines (40 loc) · 1.57 KB

Chezmoi SQLRsync Integration

A SQLRsync integration for Chezmoi that handles installation, database synchronization, and automated backup scheduling.

Quick Start

Add to your .chezmoi.toml.tmpl:

[data.sqlrsync]
  enabled = true
  install_method = "github"  # "github", "manual"
  
  [[data.sqlrsync.databases]]
    name = "staggered-repetition"
    remote = "pnwmatt/staggered-repetition.db"
    local_path = "~/.local/share/databases/staggered-repetition.db"
    sync_mode = "subscribe"  # "subscribe", "cron:push", "cron:pull"
    subscribe_flags = "--waitIdle=10s" 
    enabled = true

Then run:

chezmoi apply

Features

  • ✅ Automatic Installation: Downloads and installs SQLRsync CLI
  • ✅ Smart Sync Modes: Subscribe, pull-only, or bidirectional sync
  • ✅ Flexible Scheduling: File-change triggers, cron-style, or real-time
  • ✅ Cross-platform: Linux (systemd), macOS (launchd) support
  • ✅ Zero Downtime: No database locks or service interruption
  • ✅ Version Control: Time-travel and rollback capabilities

Configuration Options

Sync Modes

  • subscribe: Real-time bidirectional sync using websockets
  • cron:pull: Downloads latest version on a schedule for read-replicas
  • cron:push: Backup databases on a schedule

Schedule Formats

  • file_change_Xm: Push X minutes after file changes
  • daily_Xam/Xpm: Daily at specific time
  • weekly_X_Xam: Weekly on day X at time X
  • hourly: Every hour
  • cron:X X X X X: Custom cron expression

Examples

See examples/ directory for complete configuration examples.