← Back to Code Folder Sync

Getting started

Create the first synchronized folder, then join an empty destination on another machine.

Create the folder

Run the interactive setup wizard on the first peer:

codefoldersync setup

Choose create, provide the parent folder and hub location, name the folder and peer, and let the filesystem probes complete. Setup prints the folder ID needed by other peers.

Join another machine

The destination must be empty so Code Folder Sync can distinguish a safe first join from an untracked local tree.

codefoldersync setup \
  --mode join \
  --folder-id <folder-id> \
  --root /absolute/path/to/empty/code \
  --hub ssh://user@hub-host/absolute/path/to/hub \
  --peer desktop

Finish by running codefoldersync doctor, codefoldersync status, and codefoldersync verify --full before installing the background service.

On this page