Remote Sync Overview¶

Remote sync is the SSH-based path for project-local configs.

Instead of using the global backup config, you point suisave at a local TOML file:

suisave remote sync --config ./suisave.remote.toml --push

That explicit --config requirement is part of the design. Remote sync often carries project-specific paths, hosts, and credentials, so it should not quietly share the same config space as mounted-drive backups.

When to use it¶

Use remote sync when:

the destination is another machine
connection details should live with the project
you want explicit push or pull behavior

This makes remote sync a good fit for personal servers, backup boxes, and project mirrors where you already know that SSH and rsync are the transport you want.

It is also a good fit for a very common habit: keeping a small private sync config near the project so you can send or retrieve the current tree without exposing those details in the machine-wide backup config.

Main ideas¶

config is explicit via --config
transport is SSH
jobs live under [[jobs.sync]]
direction is push, pull, or most_recent

The command is still powered by rsync, but suisave handles the repetitive structure around it: resolving paths, selecting jobs, applying defaults, and deciding which side is authoritative.

That keeps the command line short while still making the config source and the sync direction explicit.

Next pages¶

If you want a guided start rather than jumping straight into the reference pages, begin with the 10-Minute Tutorial.