Page kind: Reference
swarmops sync status#
Show how main and a git remote's followed branch stand, as the last fetch saw it.
Offline: it reads the store and its mirror only, takes no lock and runs no git. A branch never fetched gives fetched false.
- Group
remotes- Since
0.2.0- Mutates
- no
- Identity required
- no
- MCP tool
sync_status- Envelope op
sync_status- Exit codes
- 0
- Errors
- none
Syntax#
swarmops sync status [OPTIONS] <REMOTE>Required arguments#
Syntax: <REMOTE>.
The remote, by its name.
Optional arguments#
The command also takes the global options.
Syntax: -n, --limit <N>.
Default: 50.
The most unpublished changesets to list.
Examples#
No recorded example yet.
No recorded example yet.
Return information#
result is a SyncStatus (swarmops schema SyncStatus prints its JSON Schema).
| Field | Type | Required | Description |
|---|---|---|---|
ahead | integer | yes | How many changes on main are above the base: unpublished. |
base | string or null | no | The newest changeset on main's first-parent chain that the remote's head reaches; omitted when there is none. |
behind | integer | yes | How many changesets on the remote's first-parent chain are above the base. |
branch | string | yes | The followed branch. |
fetched | boolean | yes | Whether a fetch ever saw the followed branch. |
remote | string | yes | The remote, by its name. |
remote_head | RemoteHead or null | no | The followed branch's head as the last fetch saw it; omitted when none did. |
truncated | boolean | yes | Whether a count or the list stopped at its bound. |
unpublished | array of ChangesetSummary | yes | The unpublished changes, newest first, at most limit. |
Envelope op: sync_status.
Exit codes:
0: Success.
Errors#
No golden step shows this command failing yet.
Any command that opens a store may also fail with a store error, such as E_NOT_A_REPO, E_IO or E_STORE_CORRUPT; a command line the grammar refuses is E_INVALID_ARG (exit 2).