Skip to content

docs: add Troubleshooting section for SSH, Full Disk Access, and rsync PATH #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BadryansahBangsawan merged 1 commit into from
Sep 18, 2026
Merged

docs: add Troubleshooting section for SSH, Full Disk Access, and rsync PATH #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,17 @@ Requires Xcode Command Line Tools and Swift 5.9+.

---

## Troubleshooting

**Sync fails immediately / "Permission denied (publickey)"**
DevFS uses your `~/.ssh/config`. Make sure the host alias resolves and your key is loaded: `ssh-add ~/.ssh/your_key`. Test the connection manually with `ssh <host>` before configuring a sync rule.

**Icon appears but sync never starts**
macOS Full Disk Access is required when syncing directories under `~/Desktop`, `~/Documents`, or `~/Downloads`. Grant it at **System Settings → Privacy & Security → Full Disk Access** and restart DevFS.

**rsync path not found**
If you installed rsync via Homebrew, the binary lives in `/opt/homebrew/bin/` which GUI apps may not see. Add it to `/etc/paths.d/homebrew` (one line: `/opt/homebrew/bin`) or symlink: `sudo ln -sf /opt/homebrew/bin/rsync /usr/local/bin/rsync`.

## Notes

– Requires rsync and ssh on PATH (included on macOS by default).
Expand Down
Loading