swarmops ws info#

Describes v0.11.0Last changed 2026-11-08View as Markdown

Describe one workspace: its directory, base, head and prefixes.

Metadata

Group: workspaces
Since: 0.3.0
Mutates: no
Identity required: no
MCP tool: ws_info
Envelope op: ws_info
Exit codes: 06
Errors: E_WS_NOT_FOUND

Syntax#

Syntax

swarmops ws info [OPTIONS]

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.

Examples#

Shell

swarmops --repo [tmp]/store --as agent/worker-17 ws info --ws nope

Output, an error

{ "ok": false, "op": "ws_info", "api": 1, "error": { "code": "E_WS_NOT_FOUND", "message": "the store has no workspace named \"nope\"", "retryable": false,

Show 13 more lines

"exit": 6, "details": { "name": "nope" }, "hint": "swarmops ws list" }, "meta": { "repo": "[tmp]/store", "elapsed_ms": "[elapsed_ms]", "resolved": {}, "auth": "trust" } }

Exit code 6. Recorded by the CLI tests. A name in square brackets, such as [tmp] or [c1], stands for what differs from run to run: the test's temporary directory, an id, a time.

No recorded example yet.

Return information#

result is a WsInfo (swarmops schema WsInfo prints its JSON Schema).

Field	Type	Required	Description
`all`	`boolean`	no	Whether the whole tree is written out.
`base`	`string`	yes	The target's changeset its chain starts from.
`created`	`boolean`	no	Whether this request made it: false for one that existed.
`head`	`string`	yes	Its chain's last changeset; `base` when nothing is committed.
`name`	`string`	yes	Its name.
`orphan`	`boolean`	no	Whether its directory is gone while its entry stays (`ws_list` with `check`).
`path`	`string`	yes	Its directory on the caller's host.
`prefixes`	`array of string`	no	The repository paths written out.
`snapshot`	`string or null`	no	Its latest snapshot (`ws_snapshot`, or an update's), on whichever head it was taken; `ws_info` only, omitted when there is none.
`status_after`	`WsStatus or null`	no	The status after the mutation; omitted when the request said `none`.

Envelope op: ws_info.

Exit codes:

0: Success.
6: Something the request names does not exist.

Errors#

E_WS_NOT_FOUND (exit 6): No workspace by that name, or at that path (details.name when named).

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).