# swarmops ws info

> Release: 0.11.0 · Last changed: 2026-11-08 · Source: https://github.com/KeiaiLab/SwarmOps/blob/stable/docs/reference/commands/ws-info.md

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

```yaml
title: "swarmops ws info"
description: "Describe one workspace: its directory, base, head and prefixes."
group: "workspaces"
since: "0.3.0"
mutates: false
identity_required: false
mcp_tool: "ws_info"
envelope_op: "ws_info"
exit_codes: [0, 6]
errors: [E_WS_NOT_FOUND]
syntax: "swarmops ws info [OPTIONS]"
```

## Syntax

```text
swarmops ws info [OPTIONS]
```

## Required arguments

None.

## Optional arguments

The command also takes the [global options](../cli.md#global-options).

### `--ws`

Syntax: `--ws <NAME>`.

The workspace, by its name in the store's registry (default: the one around the working directory).

### `--ws-path`

Syntax: `--ws-path <DIR>`.

The workspace's directory.

## Examples

### CLI

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

```json
{
  "ok": false,
  "op": "ws_info",
  "api": 1,
  "error": {
    "code": "E_WS_NOT_FOUND",
    "message": "the store has no workspace named \"nope\"",
    "retryable": false,
    "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.

### MCP

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`](../errors.md#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`](../errors.md#e_not_a_repo), [`E_IO`](../errors.md#e_io) or [`E_STORE_CORRUPT`](../errors.md#e_store_corrupt); a command line the grammar refuses is [`E_INVALID_ARG`](../errors.md#e_invalid_arg) (exit 2).

## See also

- [`swarmops ws create`](ws-create.md)
- [`swarmops ws status`](ws-status.md)
- [`swarmops ws diff`](ws-diff.md)
- [`swarmops ws commit`](ws-commit.md)
- [`swarmops ws rebase`](ws-rebase.md)
- [`swarmops ws resolve`](ws-resolve.md)
- [`swarmops ws land`](ws-land.md)
- [`swarmops ws materialize`](ws-materialize.md)
- [`swarmops ws discard`](ws-discard.md)
- [`swarmops ws snapshot`](ws-snapshot.md)
- [`swarmops ws list`](ws-list.md)
- [`swarmops ws delete`](ws-delete.md)
- [`swarmops ws hook`](ws-hook.md)
- [CLI reference](../cli.md)
- [Error codes](../errors.md)