sync¶

Inspect Openbase Sync, resolve its conflicts, and migrate from the previous sync. See Sync Between Your Computers for how Openbase Sync works, and sync-daemon for configuring it.

Usage¶

openbase-coder sync COMMAND [ARGS]

Subcommands¶

Subcommand	Description
`status [--json]`	Show the Openbase Sync role, roots, connected peer and open conflict count
`conflicts [--json]`	List open conflicts (id, root, path, kind)
`resolve ID --keep-local\\|--use-remote`	Resolve one conflict by keeping this computer's version or taking the other computer's
`migrate-from-syncthing [--apply] [--remove-markers]`	Move this machine from the previous Syncthing-based sync to Openbase Sync

status, conflicts and resolve talk to the local sync-daemon service and fail with an explanation when Openbase Sync is not configured or not running.

migrate-from-syncthing¶

A dry run by default: it prints what it would do and changes nothing.

Option	Description
`--apply`	Perform the migration
`--remove-markers`	With `--apply`: also move the old sync's `.stfolder`, `.stignore` and `.stglobalignore` files out of the previously synced folders. Use it only after the old sync service is stopped on every computer
`--replace-nested`	When a migrated root contains roots that are already configured (for example `~/Projects` over `~/Projects/app`), drop the inner roots in favour of the outer one. Without it, overlapping roots are skipped and reported
`--no-restart`	Do not restart the `sync-daemon` service after adding roots

With --apply it:

stops and uninstalls the old code-sync service if it is installed;
moves ~/.openbase/code-sync, ~/.openbase/sync-versions and ~/.openbase/sync-config.json into ~/.openbase/trash/syncthing-migration-<timestamp>/ (nothing is deleted; with sync-config.json gone, a second run has nothing left to do);
maps the previously synced folders (for example ~/Projects) plus the product folders (~/.openbase/thread-sync, ~/.agents/skills and linked skill-source folders) to Openbase Sync roots. Custom ignore rules from the previous sync are not carried over (Openbase Sync recognizes dependency and build folders itself); they stay in the trashed sync-config.json and the command prints how many were left behind;
if Openbase Sync is configured, adds the missing roots to ~/.openbase/sync/config.toml and restarts the sync-daemon service when it is installed; otherwise prints the openbase-coder sync-daemon configure ... command to run.

With --apply --remove-markers it additionally moves the old .stfolder, .stignore and .stglobalignore files out of the previously synced folders into the trash folder. Do this only once the old sync is stopped on every computer: while another computer still runs it, Openbase Sync would carry the deletion of an ignore file over, and the old sync there would start copying .git directories.

Recommended order: run --apply on each computer, then, once all of them are done, --apply --remove-markers.

The command is idempotent and safe on a machine that never used the previous sync.

Examples¶

openbase-coder sync status
openbase-coder sync conflicts
openbase-coder sync resolve 42 --use-remote

# Preview, then perform, the migration from the previous sync (each computer)
openbase-coder sync migrate-from-syncthing
openbase-coder sync migrate-from-syncthing --apply

# After every computer is migrated: remove the old markers
openbase-coder sync migrate-from-syncthing --apply --remove-markers

Notes¶

Earlier sync enable, disable, add, remove, ignores, heal-echoes, reconcile and install-engine subcommands were removed with the previous sync. Choose what to sync on the console Sync page, or with openbase-coder sync-daemon pair / configure --root ....
The phone apps read the same state through /api/sync/status/, /api/sync/conflicts/ and /api/sync/conflicts/resolve/; the console uses /api/sync/daemon/....