# Sandbox CLI reference

Source: `@socra/sandbox-cli@0.0.5`.

This reference includes every command, argument, and option declared by this released package. Defaults and accepted values are included where the package declares them. Command-specific validation and permissions also apply; see the [API reference](/docs/sandbox/reference/api) for resource contracts.

Use `socra sandbox --help`, or append `--help` to any command, to inspect the locally installed version.

## socra sandbox

Durable project environments with isolated Kata Sessions

| Command | Purpose |
| --- | --- |
| `socra sandbox create` | Create a durable Sandbox and start its initial Session |
| `socra sandbox get` | Show a Sandbox |
| `socra sandbox list` | List project Sandboxes |
| `socra sandbox update` | Update Sandbox Session policy |
| `socra sandbox start` | Start or return the active Session |
| `socra sandbox stop` | Stop the active Session and checkpoint /home |
| `socra sandbox restart` | Checkpoint and replace the active Session |
| `socra sandbox exec` | Execute a command, resuming the Sandbox if needed |
| `socra sandbox delete` | Delete a Sandbox, its Sessions, home, and Snapshots |
| `socra sandbox session` | Observable Kata microVM incarnations of durable Sandboxes |
| `socra sandbox snapshot` | Immutable persistent-home checkpoints |

## socra sandbox create

Create a durable Sandbox and start its initial Session

```text
socra sandbox create [options]
```

### Options

| Option | Input | Description |
| --- | --- | --- |
| `--project` | Value | Project id or slug |
| `--image` | Value | OCI image |
| `--timeout` | Value | Session duration, e.g. 30m or 24h |
| `--ephemeral` | Presence flag | Discard /home when the Session ends |
| `--storage` | Value | Persistent /home size in GiB (default 20) |
| `--command` | Value | JSON argv array for the Session process |
| `--stopped` | Presence flag | Create without starting an initial Session |

## socra sandbox get

Show a Sandbox

```text
socra sandbox get <id>
```

### Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Sandbox id |

## socra sandbox list

List project Sandboxes

```text
socra sandbox list [options]
```

### Options

| Option | Input | Description |
| --- | --- | --- |
| `--project` | Value | Project id or slug |
| `--status` | Value | Sandbox status |
| `--limit` | Value | Page size |
| `--after` | Value | Page cursor |

## socra sandbox update

Update Sandbox Session policy

```text
socra sandbox update <id> [options]
```

### Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Sandbox id |

### Options

| Option | Input | Description |
| --- | --- | --- |
| `--timeout` | Value | Duration such as 30m or 24h |

## socra sandbox start

Start or return the active Session

```text
socra sandbox start <id>
```

### Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Sandbox id |

## socra sandbox stop

Stop the active Session and checkpoint /home

```text
socra sandbox stop <id>
```

### Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Sandbox id |

## socra sandbox restart

Checkpoint and replace the active Session

```text
socra sandbox restart <id>
```

### Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Sandbox id |

## socra sandbox exec

Execute a command, resuming the Sandbox if needed

```text
socra sandbox exec <id> [options]
```

### Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Sandbox id |

### Options

| Option | Input | Description |
| --- | --- | --- |
| `--command` | Value | JSON argv array |

## socra sandbox delete

Delete a Sandbox, its Sessions, home, and Snapshots

```text
socra sandbox delete <id>
```

### Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Sandbox id |

## socra sandbox session

Observable Kata microVM incarnations of durable Sandboxes

| Command | Purpose |
| --- | --- |
| `socra sandbox session create` | Start or return the active Session for a Sandbox |
| `socra sandbox session get` | Show a Session |
| `socra sandbox session list` | List Session history |
| `socra sandbox session update` | Reset a running Session timeout |
| `socra sandbox session stop` | Stop a Session and checkpoint persistent home |
| `socra sandbox session exec` | Execute a command in a running Session |

## socra sandbox session create

Start or return the active Session for a Sandbox

```text
socra sandbox session create [options]
```

### Options

| Option | Input | Description |
| --- | --- | --- |
| `--sandbox` | Value | Sandbox id |

## socra sandbox session get

Show a Session

```text
socra sandbox session get <id>
```

### Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Session id |

## socra sandbox session list

List Session history

```text
socra sandbox session list [options]
```

### Options

| Option | Input | Description |
| --- | --- | --- |
| `--project` | Value | Project id or slug |
| `--sandbox` | Value | Sandbox filter |
| `--status` | Value | Session status |
| `--limit` | Value | Page size |
| `--after` | Value | Page cursor |

## socra sandbox session update

Reset a running Session timeout

```text
socra sandbox session update <id> [options]
```

### Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Session id |

### Options

| Option | Input | Description |
| --- | --- | --- |
| `--timeout` | Value | Duration such as 30m or 24h |

## socra sandbox session stop

Stop a Session and checkpoint persistent home

```text
socra sandbox session stop <id>
```

### Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Session id |

## socra sandbox session exec

Execute a command in a running Session

```text
socra sandbox session exec <id> [options]
```

### Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Session id |

### Options

| Option | Input | Description |
| --- | --- | --- |
| `--command` | Value | JSON argv array |

## socra sandbox snapshot

Immutable persistent-home checkpoints

| Command | Purpose |
| --- | --- |
| `socra sandbox snapshot create` | Checkpoint a persistent Sandbox home |
| `socra sandbox snapshot get` | Show a Snapshot |
| `socra sandbox snapshot delete` | Delete a Snapshot and its EBS checkpoint |
| `socra sandbox snapshot list` | List filesystem Snapshots |

## socra sandbox snapshot create

Checkpoint a persistent Sandbox home

```text
socra sandbox snapshot create [options]
```

### Options

| Option | Input | Description |
| --- | --- | --- |
| `--sandbox` | Value | Sandbox id |

## socra sandbox snapshot get

Show a Snapshot

```text
socra sandbox snapshot get <id>
```

### Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Snapshot id |

## socra sandbox snapshot delete

Delete a Snapshot and its EBS checkpoint

```text
socra sandbox snapshot delete <id>
```

### Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Snapshot id |

## socra sandbox snapshot list

List filesystem Snapshots

```text
socra sandbox snapshot list [options]
```

### Options

| Option | Input | Description |
| --- | --- | --- |
| `--project` | Value | Project id or slug |
| `--sandbox` | Value | Sandbox filter |
| `--status` | Value | Snapshot status |
| `--limit` | Value | Page size |
| `--after` | Value | Page cursor |

## Next step

Return to the [Sandbox overview](/docs/sandbox).

---

Company: Socra — Multiply Your Judgment
Canonical URL: https://cloud.socra.com/docs/sandbox/reference/cli