> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ankra.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# ankra workspace

> Manage this checkout's Ankra Workspace, where 'ankra exec' runs commands

## ankra workspace

An Ankra Workspace is your long-lived pod on the organisation's CI pool,
built from the repository's workspace profile (or its pipeline's image), that
'ankra exec' runs heavy commands in instead of on this machine.

The repository is the checkout's origin remote (GitHub, GitLab or Bitbucket),
which must be connected to Ankra Pipelines. Each repository has one workspace
per kind (default "default"); 'ankra exec `--kind` K' uses the K one.

Needs the workspaces.use permission.

## ankra workspace down

Tear this checkout's workspace of the given kind down: its pod, its volume and
everything synced into it. The next 'ankra exec' or 'ankra workspace up'
brings a fresh one up (and sends the checkout's history again).

Asks for confirmation unless `--yes` is given; declining exits 4. Exits 3 when
there is no live workspace of that kind.

```bash theme={null}
ankra workspace down [flags]
```

**Examples**

```bash theme={null}
ankra workspace down
  ankra workspace down --kind playwright --yes
```

**Flags**

| Flag | Default | Description |
| - | - | - |
| `--kind` | `default` | Workspace kind to tear down |
| `-o`, `--output` | | Output format: json or yaml (default: human-readable) |
| `-y`, `--yes` | `false` | Skip the confirmation prompt |

## ankra workspace status

Show this checkout's live workspaces (every kind, or the `--kind` one). Reading a
provisioning workspace moves it on: the platform runs its preflight.

Exit codes: 0 when a workspace was found, 3 when the repository has none (or
is not connected to Ankra Pipelines).

```bash theme={null}
ankra workspace status [flags]
```

**Examples**

```bash theme={null}
ankra workspace status
  ankra workspace status --kind playwright -o json
```

**Flags**

| Flag | Default | Description |
| - | - | - |
| `--kind` | | Only the workspace of this kind |
| `-o`, `--output` | | Output format: json or yaml (default: human-readable) |

## ankra workspace up

Bring this checkout's workspace of the given kind up, or answer the one that
is already live. A new workspace starts provisioning; `--wait` reads it until it
is ready (the platform runs its preflight on each read) or failed.

Exit codes: 0 when the workspace is up (ready, or provisioning without `--wait`),
1 when it failed, 5 when `--wait` timed out.

```bash theme={null}
ankra workspace up [flags]
```

**Examples**

```bash theme={null}
ankra workspace up
  ankra workspace up --kind playwright --wait
```

**Flags**

| Flag | Default | Description |
| - | - | - |
| `--kind` | `default` | Workspace kind (the repository's workspace profile) |
| `-o`, `--output` | | Output format: json or yaml (default: human-readable) |
| `--timeout` | `16m0s` | How long `--wait` waits |
| `--wait` | `false` | Wait until the workspace is ready or failed |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.