Sandboxes

sim sandboxes is also spelled sim sandbox.

These commands accept the global options.

List sandboxes

Code

sim sandboxes list [options]

Options

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`.

API request and response schemas: listSandboxes.

Code

sim sandboxes get <sandboxId>

Arguments

Argument	Required	Description
`sandboxId`	Yes	Unique sandbox identifier.

API request and response schemas: getSandbox.

OAuth login or personal API key required.

Code

sim sandboxes create [options]

Options

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 @).

API request and response schemas: createSandbox.

OAuth login or personal API key required.

Code

sim sandboxes update <sandboxId> [options]

Arguments

Argument	Required	Description
`sandboxId`	Yes	Unique sandbox identifier.

Options

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 @).

API request and response schemas: updateSandbox.

OAuth login or personal API key required.

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

Code

sim sandboxes delete <sandboxId> [options]

Arguments

Argument	Required	Description
`sandboxId`	Yes	Unique sandbox identifier.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteSandbox.