mxr sync
Generated from
mxr sync --help. Edit the clap definitions incrates/daemon/src/cli/and re-runnpm run buildinsite/to regenerate.
Trigger or query sync. Triggering starts a sync in the daemon and returns as soon as it has started; the account keeps syncing afterwards, through the rest of a backfill and any queued tick. Use –wait to wait for the account itself to go idle
mxr sync [OPTIONS]Options
Section titled “Options”| Flag | Description |
|---|---|
--account <ACCOUNT> |
— |
--status |
— |
--wait |
Keep waiting until the account itself reports idle, then print its status in JSON mode |
--wait-timeout-secs <WAIT_TIMEOUT_SECS> |
Maximum seconds –wait spends waiting for the account to go idle; does not bound the sync itself. Default 60 [default: 60] |
--format <FORMAT> |
Output format. JSON prints the trigger’s acknowledgement, and with –wait the account’s final status [possible values: table, json, jsonl, csv, ids] |
-h, --help |
Print help |
Use When
Section titled “Use When”Trigger a sync and return, or hold until the account goes idle. The trigger acks as soon as the sync has started; --wait polls for idle and prints live progress. --wait-timeout-secs bounds the wait, not the sync.
Everyday Examples
Section titled “Everyday Examples”mxr syncmxr sync --wait --wait-timeout-secs 900 # a first backfill outlasts the 60s defaultmxr sync --status --format json | jq '.[] | {account_name, sync_in_progress, progress}'See also
Section titled “See also”- CLI overview — full command index
- Concepts — query operators, search modes, JSON shapes
- Automation contract — which commands support
--format json,--dry-run, stdin