Skip to Content
Getting started

Getting started

From a fresh install to your first synced folder. If treesync isn’t installed yet, see Installation.

One command

From inside the folder that holds all your repos, run:

treesync init

treesync init does the whole setup in one step: signs this device in, offers to sync the current folder, runs the first sync, and installs a background daemon that watches the folder and syncs every change in real time — starting automatically each time you log in.

That’s it. The rest of this page is the same setup, broken into individual commands if you’d rather run them by hand.

Step by step

Sign in

treesync login

treesync prints a verification URL (and opens your browser when it can); confirm the device in your account to link it. Each device gets its own identity, so you can revoke them individually later.

On first login, treesync sets up your end-to-end encryption key and shows your recovery codes. Save them — they’re the only way back in if you lose every device. See Security & privacy.

Add your code folder

treesync add ~/code

Point treesync at the single parent folder that holds your repositories — not each repo individually. It mirrors everything inside: every repo, every file, including each repo’s .git. New repos you drop in later are picked up automatically. To exclude paths, see Configuration.

Run your first sync

treesync push

treesync chunks and encrypts what changed and uploads only the pieces not already stored. The first push of a large repo uploads the most; later pushes are fast because only changed chunks move.

Keep it syncing

treesync start

start installs and launches the background daemon, so changes sync the moment they happen — no more manual push. Check on it any time:

treesync status # folders, sync state, in-flight transfers treesync service status # is the daemon installed and running?

Next

  • On another device: install treesync and run treesync init with the same account — your code is available there.
  • Exclude build output: Configuration.
  • Curious how it works: How sync works.
  • Hit a snag: Troubleshooting.