sync_status#

Describes v0.11.0Last changed 2026-10-22View as Markdown

How main and a git remote's followed branch stand, as the last fetch saw the remote: how many changes are unpublished and how far behind main is, offline; pass a limit of 100 or less.

Metadata

Since: 0.2.0
Mutates: no
Identity required: no
Envelope op: sync_status
Cli command: swarmops sync status
Request type: SyncStatusReq
Annotations: {"destructiveHint":false,"idempotentHint":true,"openWorldHint":false,"readOnlyHint":true}
Max result chars: null
CLI command: swarmops sync status

Input schema#

arguments is a SyncStatusReq: swarmops schema SyncStatusReq prints the type. A field the type does not know is ignored.

Field	Type	Required	Default	Description
`limit`	integer	no	`50`	The most unpublished changesets to list.
`remote`	string	yes		The remote, by its name.

JSON Schema#

As tools/list gives it: each $ref replaced by its definition, so that it stands alone.

JSON

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "`sync status`: how `main` and a remote's followed branch stand, as the last fetch saw the\nremote. It reads only the store and its mirror: no network, no lock.",
  "properties": {
    "limit": {
      "default": 50,
      "description": "The most unpublished changesets to list.",
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "remote": {
      "description": "The remote, by its name.",
      "type": "string"
    }
  },
  "required": [
    "remote"
  ],
  "title": "SyncStatusReq",
  "type": "object"
}

Annotations#

It only reads the store.

Annotation	Value	Meaning
`destructiveHint`	`false`	True: a tool that changes the store may overwrite or delete what is there, not only add to it.
`idempotentHint`	`true`	True: calling it again with the same arguments changes nothing more.
`openWorldHint`	`false`	True: it reaches beyond a closed set of things. Every tool here stays inside the store.
`readOnlyHint`	`true`	True: the tool does not change its environment, the store.

Its entry in tools/list carries no _meta.

CLI command#

swarmops sync status runs the same operation and prints the same envelope.

Examples#

No recorded example yet.

Return information#

A tool result: the envelope, whose op is sync_status, as structuredContent and again as the text of its one content block. isError is true exactly when the envelope's ok is false. On success the envelope's result is what swarmops sync status returns.

Errors#

A failed call is a tool result with isError: true; the envelope's error.code is one of the error codes.

E_INVALID_ARG: arguments that do not fit SyncStatusReq, a field named twice among them included, or that break one of the server's own rules.
E_NOT_A_REPO: the server's store is not there; the server serves on.
E_INTERNAL: the operation panicked, a bug.

Then the errors of the operation, as swarmops sync status lists them.