Skip to content
Izunim edited this page Feb 27, 2026 · 3 revisions

Doctor

The doctor command runs a series of health checks on your synx setup and reports issues.

synx --doctor

Checks Performed

# Check Severity What it looks for
1 Git repository Error Is ~/dotfiles a valid git repo?
2 Remote configured Error Does the repo have an origin remote? Shows the URL
3 Unpushed commits Warning Are there local commits not yet pushed?
4 Targets count Info How many dotfile dirs are tracked
5 Missing targets Warning Targets in config that don't exist in ~/.config
6 Broken symlinks Error Tracked targets that are dead symlinks
7 Suggested configs Info Popular config dirs on your system that you're not tracking yet, with synx --add commands
8 Orphaned excludes Warning Exclude patterns that don't match anything
9 Machine config Info Hostname detection
10 Config permissions Warning Are synx.conf and exclude.conf readable/writable?
11 Hooks directory Info If hooks dir exists, shows hook count
12 Profiles Info If profiles exist, shows count and active profile
13 Package state Warning Is there a saved package list? Shows native and AUR counts
14 Service state Warning Is there a saved service list? Shows system and user counts

Example Output

╭──────────────────╮
│ 🩺 SYNX - Doctor │
╰──────────────────╯

→ Running health checks...

  ✓ Git repository OK
  ✓ Remote configured (git@github.com:Blumenwagen/dotfiles.git)
  ✓ No unpushed commits
  ✓ 6 targets tracked
  ✓ No broken symlinks
  ✓ Machine: arch
  ✓ Package state: 275 native, 16 foreign (AUR)
  ✓ Service state: 34 system, 7 user

─────────────────────────────────────
8 passed  │  0 warnings  │  0 errors
─────────────────────────────────────

When to Run

  • After a fresh install to verify everything is set up
  • If sync or restore is behaving unexpectedly
  • After modifying exclude patterns to check for orphans
  • Periodically as a general check-up

Clone this wiki locally