Skip to content

Commands

Izunim edited this page Feb 27, 2026 · 5 revisions

Commands

Sync & Restore

Command Description
synx Sync dotfiles to remote — copies configs to repo, commits, and pushes
synx -r / --restore Pull latest from remote and restore dotfiles to ~/.config
synx -n / --dry-run Preview what sync or restore would do, without touching any files

Dry-run works with both sync and restore:

synx -n          # Preview sync
synx -r -n       # Preview restore

Status & Diagnostics

Command Description
synx -s / --status Compare live ~/.config files against last sync, shows modified/new/deleted
synx --remote-diff Fetch from remote and show a full git diff of local vs remote
synx --doctor Run health checks — see Doctor
synx --history Show the last 20 git commits in the dotfiles repo

Target Management

Command Description
synx --add <name> Start tracking a ~/.config/<name> directory
synx --remove <name> Stop tracking a directory
synx --clean Interactively discover and completely remove orphaned dotfiles from the repository
synx --exclude <path> Exclude a file pattern from syncing (and remove matching files from repo)
synx --list Launch interactive dashboard to view tracked dotfiles and instantly add new ones
synx --rollback Launch interactive TUI showing commit diffs to select a rollback point
synx --rollback <n> Headless mode: Reset the dotfiles repo by n commits, force push, and restore

Profiles

Command Description
synx --profile <name> Apply a named profile — see Profiles
synx --profile-list List available profiles, shows active one
synx --profile-create <name> Create a new empty profile directory
synx --profile-delete <name> Delete a profile

Bootstrap

Command Description
synx --bootstrap-setup Interactive wizard to create a bootstrap config
synx --bootstrap <url> Clone a dotfiles repo and bootstrap from its config

See Bootstrap for full details.

Modifiers

These flags modify the behavior of other commands:

Flag Effect
-m / --machine Target machine-specific config instead of shared base
--yes Skip per-step confirmations during bootstrap
--update Auto-update synx to the latest repository commit
-v / --version Display the dynamically generated version number

Packages & Services

Command Description
synx pkg sync Snapshot installed packages (pacman + AUR) — see Packages
synx pkg status Show packages added/removed since last snapshot
synx pkg restore Install missing packages from saved list
synx pkg list Display saved package list
synx svc sync Snapshot enabled systemd services — see Services
synx svc status Show services added/removed since last snapshot
synx svc restore Enable missing services from saved list
synx svc list Display saved service list

Note: synx pkg requires pacman (Arch-based). synx svc requires systemctl (systemd-based). Other synx commands work on any system.

Clone this wiki locally