Atomus logoAtomus

Sync and backup

Sync your vault between Macs with Git, using a remote you choose. Back it up like any other folder.

Atomus doesn't run its own cloud. To use the same vault on more than one Mac, Atomus syncs it through Git, to a remote you choose: GitHub, GitLab, your own server, or anything else that speaks Git. It's optional and off by default.

Set up Git sync

You need Git on your Mac. If it's missing, run xcode-select --install in Terminal.

  1. Create an empty private repository with your Git host.
  2. Open Settings → Sync and turn on Enable sync, or use the Setup wizard.
  3. Enter the Remote URL and Branch, plus an author name, email, and device name for the commits.
  4. Do the same on your other Mac, with the same remote.

Atomus uses your existing Git credentials, such as an SSH key or the macOS Keychain, to reach the remote.

What syncs

  • Your notes: every Markdown file and folder in the vault, including Attachments/
  • .atomus/reviews.jsonl: your review history
  • .atomus/cards-state.jsonl: the scheduling state of each atom
  • .atomus/vault.json and .atomus/settings.json: the vault's ID and per-vault settings

What doesn't sync: .trash/, and the SQLite cache in ~/Library/Application Support/Atomus/. Each Mac rebuilds its own cache from the synced files.

How it runs

  • Pull on launch fetches the latest changes when Atomus starts.
  • After you edit notes or review atoms, Atomus commits the changes after a short delay (Commit every).
  • Auto push sends commits to the remote on a timer (Push every).
  • Sync now pulls, commits anything pending, and pushes right away.

A small status indicator in the editor shows when a sync is running, done, or needs attention.

Conflicts

If both Macs changed the review files, Atomus merges them automatically. If both changed the same note, Atomus stops and shows a conflict instead of guessing. Resolve it in the repository with your usual Git tools, then press Sync now.

To keep conflicts rare, let one Mac finish syncing before you switch to the other.

Backup

Time Machine, or any tool that backs up your home folder, picks up the vault like everything else. With Git sync on, your remote also holds the full history of every note.

For an extra copy, zip the vault folder and keep it somewhere safe. Notes and review history are all in there.