Page kind: Reference
swarmops ws status#
What changed in a workspace against its head, and how far its target has moved.
- Group
workspaces- Since
0.3.0- Mutates
- no
- Identity required
- no
- MCP tool
ws_status- Envelope op
ws_status- Exit codes
- 0
- Errors
- none
Syntax#
swarmops ws status [OPTIONS] [PATH]...Required arguments#
None.
Optional arguments#
The command also takes the global options.
Syntax: --ws <NAME>.
The workspace, by its name in the store's registry (default: the one around the working directory).
Syntax: --ws-path <DIR>.
The workspace's directory.
Syntax: <PATH>.
Only these repository paths, and what is below them.
Syntax: --full.
Hash every file instead of trusting unchanged stats.
Syntax: --limit <N>.
Default: 500.
The most changes to print.
Syntax: --cursor <C>.
Where the previous page stopped.
Examples#
No recorded example yet.
No recorded example yet.
Return information#
result is a WsStatus (swarmops schema WsStatus prints its JSON Schema).
| Field | Type | Required | Description |
|---|---|---|---|
base | string | yes | The target's changeset its chain starts from. |
behind_by | integer | yes | How many changesets the target's first-parent history holds that base's lacks: those past base when it is on that history; otherwise (a sync dropped it, or the target moved back) those before where the two histories meet, 0 when the target head is on base's first-parent history fewer than 10,000 changesets behind base. At most 10,000. |
changes | array of WsChange | yes | The changes, by path. |
cursor | string or null | no | Where this page stopped. |
head | string | yes | Its chain's last changeset. |
main | string | yes | The head of the workspace's target ref (main, or release/<name>), read first. |
name | string | yes | The workspace's name. |
outside | array of string | no | A sparse workspace's topmost entries off its prefixes, in path order: edits ws commit and ws land refuse until ws materialize widens the prefixes. At most the first 1,000, on every page. |
outside_truncated | boolean | no | Whether outside stopped at 1,000 entries. |
rebasing | WsRebasing or null | no | The rebase in progress, when state is rebasing. |
state | WsState | yes | Whether the workspace is rebasing. |
truncated | boolean | yes | Whether more changes follow: give cursor to read them. |
Envelope op: ws_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).