deno sandbox

The deno sandbox command allows you to spin up a secure Linux microVM, designed for running untrusted code in a sandboxed environment. See the Sandbox documentation for more detailed examples of usage.

Authentication Jump to heading#

In order to use the deno sandbox command, you need to have a Deno Deploy account and a valid authentication token. Follow the instructions in the Getting started with Deno Sandbox documentation.

Global options Jump to heading#

• -h, --help - Show this help.
• --token - Auth token to use
• --config - Path for the config file
• --org - The name of the organization

Subcommands Jump to heading#

Create a new sandbox Jump to heading#

Creates a new sandbox in an organization. Accepts the aliases create and new.

deno sandbox create

List your sandboxes Jump to heading#

Lists all sandboxes in an organization. Accepts the aliases list and ls.

deno sandbox list

Kill a sandbox Jump to heading#

Terminates a running sandbox immediately. Accepts the aliases kill, remove, and rm.

deno sandbox kill <sandbox-id>

Copy files Jump to heading#

Copies files between your local machine and a running sandbox. Use copy or its shorter alias cp.

deno sandbox copy <paths...>

Execute a command Jump to heading#

Runs an arbitrary command inside an existing sandbox.

deno sandbox exec <sandbox-id> <command...>

Example:

deno sandbox exec sbx-1234 uptime

Extend timeout Jump to heading#

Extends how long a sandbox stays active before timing out.

deno sandbox extend <sandbox-id> <timeout>

Accepts time durations in the format of a number followed by a unit, where the unit can be s for seconds, m for minutes, or h for hours.

Example:

deno sandbox extend <sandbox-id> 30m

SSH into a sandbox Jump to heading#

Opens an interactive SSH session to the sandbox.

deno sandbox ssh <sandbox-id>

Deploy a sandbox Jump to heading#

Turns the state of a running sandbox into a Deno Deploy application.

deno sandbox deploy <sandbox-id> <app>

Manage volumes Jump to heading#

Creates, lists, and attaches persistent block volumes.

deno sandbox volumes --help

Create a volume Jump to heading#

Creates a new volume. Accepts the alias volumes create or volumes new.

deno sandbox volumes create <name>

List volumes Jump to heading#

Lists all volumes in an organization. Accepts the alias volumes list or volumes ls.

deno sandbox volumes list

Delete a volume Jump to heading#

Deletes a volume. Accepts the alias volumes delete, volumes rm or volumes remove.

deno sandbox volumes delete <volume-id-or-slug>

or

deno sandbox volumes delete <volume-slug>

Snapshot a volume Jump to heading#

Creates a snapshot of a volume. Accepts a volume ID or slug and a snapshot slug

deno sandbox volumes snapshot <volume-id-or-slug> <snapshot-slug>

or

deno sandbox volumes snapshot <volume-slug> <snapshot-slug>

Manage snapshots Jump to heading#

Creates and restores filesystem snapshots for sandboxes.

deno sandbox snapshots --help

Create a snapshot Jump to heading#

Creates a new snapshot of a sandbox. Accepts the alias snapshots create or snapshots new. It requires a volume ID or volume slug and a snapshot slug.

deno sandbox snapshots create <volume-id-or-slug> <snapshot-slug>

List snapshots Jump to heading#

Lists all snapshots in an organization. Accepts the alias snapshots list or snapshots ls.

deno sandbox snapshots list

Delete a snapshot Jump to heading#

Deletes a snapshot. Accepts the alias snapshots delete, snapshots rm or snapshots remove. It requires a snapshot ID or snapshot slug.

deno sandbox snapshots delete <id-or-slug>

Switch organizations or apps Jump to heading#

Switches your current Deploy organization or application context, which the sandbox command uses for authentication.

deno sandbox switch

deno sandbox [OPTIONS] [args]...