CLI reference / Background sync

CLI reference

Background sync

wiele daemon, live and sync: upload and download changes in the background.

One background process per user runs two independent modes per checkout. sync pulls remote changes about every 30 seconds and works on any branch. live uploads stable local edits about every 5 seconds and works only on branches other than main. Enabling either mode starts the background process. See Background sync for how they behave.

wiele daemon start

Start the background process that runs live uploads and sync.

wiele daemon start [flags]

wiele daemon status

Show whether the background process runs and the checkouts it manages.

wiele daemon status [flags]

wiele daemon stop

Stop the background process after it finishes its current work.

wiele daemon stop [flags]
Flag Description
--wait string How long to wait for it to stop. Default: 30s.

wiele daemon install

Install a launchd or systemd user service that runs the daemon at login.

wiele daemon install [flags]
Flag Description
--no-start Write the service file without starting it. The output lists the commands to start it.

wiele daemon uninstall

Stop and remove the daemon user service.

wiele daemon uninstall [flags]

wiele daemon logs

Show recent background events: uploads, downloads, pauses and retries, with stable codes.

wiele daemon logs [flags]
Flag Description
--limit integer Number of events, 1 to 1,000. Default: 100.

wiele sync status

Show whether download sync is on for a checkout.

wiele sync status [flags]
Flag Description
--directory string Checkout folder. Default: the current folder.

wiele sync enable

Pull remote changes into a checkout about every 30 seconds. Works on main.

wiele sync enable [flags]
Flag Description
--directory string Checkout folder. Default: the current folder.
--wait string Accepted for symmetry; enabling returns at once.

wiele sync disable

Turn download sync off for a checkout.

wiele sync disable [flags]
Flag Description
--directory string Checkout folder. Default: the current folder.
--wait string How long to wait for the current round to finish. Default: 30s.

wiele sync pause

Same as sync disable. Use it before a read that must not change underneath you.

wiele sync pause [flags]
Flag Description
--directory string Checkout folder. Default: the current folder.
--wait string How long to wait for the current round to finish. Default: 30s.

wiele sync resume

Same as sync enable.

wiele sync resume [flags]
Flag Description
--directory string Checkout folder. Default: the current folder.
--wait string Accepted for symmetry; resuming returns at once.

wiele live status

Show whether live uploads are on for a checkout.

wiele live status [flags]
Flag Description
--directory string Checkout folder. Default: the current folder.

wiele live enable

Upload stable local edits, deletions included, to the checkout's branch automatically. Refused on main.

wiele live enable [flags]
Flag Description
--directory string Checkout folder. Default: the current folder.
--wait string Accepted for symmetry; enabling returns at once.

wiele live disable

Turn live uploads off for a checkout.

wiele live disable [flags]
Flag Description
--directory string Checkout folder. Default: the current folder.
--wait string How long to wait for the current upload round to finish. Default: 30s.

wiele live lease

Renew or release a branch's live-writer lease. The background process runs this itself; you rarely need it.

wiele live lease [flags]
Flag Description
--org string Organization ID or slug. Default: the checkout's organization when the workspace comes from the checkout, otherwise the one picked with wiele org use.
--workspace string Required. Workspace ID, such as ws_..., from wiele workspace list. This command does not look up names or slugs.
--branch string, --copy string Required. Branch ID. --copy is the same flag.
--checkout string Required. Checkout ID holding the lease.
--action renew|release Required. renew or release.