# Sandboxes (/cli/sandboxes)





Manage reusable dependency sets for Function blocks.

`sim sandboxes` is also spelled `sim sandbox`.

These commands accept the [global options](/cli/commands#global-options).

## List sandboxes [#list-sandboxes]

```bash
sim sandboxes list [options]
```

**Options**

<CommandTable>
  | Option | Required | Description |
  | - | - | - |
  | `--search <value>` | No | Case-insensitive substring match against the sandbox name. |
  | `--sort-by <value>` | No | Field used to sort the result. Do not rely on case-insensitive ordering when sorting by `name`. Defaults to "name". Accepted values: `name`, `createdAt`, `updatedAt`. |
  | `--sort-order <value>` | No | Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`. |
  | `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `0`. |
</CommandTable>

API request and response schemas: [listSandboxes](/api-reference/sandboxes/listSandboxes).

## Get sandbox [#get-sandbox]

```bash
sim sandboxes get <sandboxId>
```

**Arguments**

<CommandTable>
  | Argument | Required | Description |
  | - | - | - |
  | `sandboxId` | Yes | Unique sandbox identifier. |
</CommandTable>

API request and response schemas: [getSandbox](/api-reference/sandboxes/getSandbox).

## Create sandbox [#create-sandbox]

OAuth login or personal API key required.

```bash
sim sandboxes create [options]
```

**Options**

<CommandTable>
  | Option | Required | Description |
  | - | - | - |
  | `--name <value>` | Yes | Display name, unique within the workspace; 1 to 64 characters. |
  | `--language <value>` | Yes | Dependency ecosystem: `javascript` installs from npm, `python` from PyPI. Accepted values: `javascript`, `python`. |
  | `--dependencies <value...>` | No | Package specifiers installed into the sandbox, one per entry. Defaults to \[]. (space-separated, or @path / @- with one value per line; in a file, blank lines and # comments are ignored, while inline values are sent as typed and may not be empty; @@value for a literal leading @). |
  | `--cli-tools <value...>` | No | Pinned managed CLI ids installed into the sandbox, at most 10, no duplicates. Defaults to \[]. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). |
  | `--system-packages <value...>` | No | Debian packages installed into the sandbox, one per entry. Defaults to \[]. (space-separated, or @path / @- with one value per line; in a file, blank lines and # comments are ignored, while inline values are sent as typed and may not be empty; @@value for a literal leading @). |
</CommandTable>

API request and response schemas: [createSandbox](/api-reference/sandboxes/createSandbox).

## Update sandbox [#update-sandbox]

OAuth login or personal API key required.

```bash
sim sandboxes update <sandboxId> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description |
  | - | - | - |
  | `sandboxId` | Yes | Unique sandbox identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option | Required | Description |
  | - | - | - |
  | `--name <value>` | No | New display name, unique within the workspace; 1 to 64 characters. |
  | `--language <value>` | No | Replacement dependency ecosystem. The whole spec is revalidated against it, so a Python dependency list does not survive a switch to JavaScript. Accepted values: `javascript`, `python`. |
  | `--dependencies <value...>` | No | Replacement package list; replaces the whole list. (space-separated, or @path / @- with one value per line; in a file, blank lines and # comments are ignored, while inline values are sent as typed and may not be empty; @@value for a literal leading @). |
  | `--cli-tools <value...>` | No | Replacement managed CLI list; replaces the whole list. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). |
  | `--system-packages <value...>` | No | Replacement Debian package list; replaces the whole list. (space-separated, or @path / @- with one value per line; in a file, blank lines and # comments are ignored, while inline values are sent as typed and may not be empty; @@value for a literal leading @). |
</CommandTable>

API request and response schemas: [updateSandbox](/api-reference/sandboxes/updateSandbox).

## Delete sandbox [#delete-sandbox]

OAuth login or personal API key required.

This deletes the sandbox; Function blocks that select it fail until re-pointed.

```bash
sim sandboxes delete <sandboxId> [options]
```

**Arguments**

<CommandTable>
  | Argument | Required | Description |
  | - | - | - |
  | `sandboxId` | Yes | Unique sandbox identifier. |
</CommandTable>

**Options**

<CommandTable>
  | Option | Required | Description |
  | - | - | - |
  | `-y, --yes` | Yes | Confirm this operation. |
</CommandTable>

API request and response schemas: [deleteSandbox](/api-reference/sandboxes/deleteSandbox).

## Related docs [#related-docs]

* [Function sandboxes](/workflows/blocks/function#sandboxes)
