Page kind: Reference
swarmops ws list#
Describes v0.11.0Last changed View as Markdown
List the store's workspaces.
Metadata
- Group
workspaces- Since
0.3.0- Mutates
- no
- Identity required
- no
- MCP tool
ws_list- Envelope op
ws_list- Exit codes
- 0
- Errors
- none
Syntax#
swarmops ws list [OPTIONS]Required arguments#
None.
Optional arguments#
The command also takes the global options.
Syntax: --check.
Also open each, and report one whose directory is gone as an orphan.
Examples#
No recorded example yet.
No recorded example yet.
Return information#
result is a WsList (swarmops schema WsList prints its JSON Schema).
| Field | Type | Required | Description |
|---|---|---|---|
workspaces | array of WsInfo | yes | The workspaces. |
Envelope op: ws_list.
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).