Skip to content

Cloud sandboxes

Create sandboxes, run commands in them, and move files in and out.

These commands follow the output contract: JSON when stdout is not a terminal, failures as JSON on stderr, and exit codes 0 to 6.

Terminal window
dexto cloud sandboxes create build
dexto cloud sandboxes start "$SANDBOX"
dexto cloud sandboxes exec "$SANDBOX" -- npm test

exec prints the command’s output and exits with its exit code. Create a sandbox, start it, then run commands in it. delete and rm need --yes.

Generated from dexto 2.0.0-beta.0.

dexto cloud sandboxes list

List the project's sandboxes.

dexto cloud sandboxes list
Option What it does
--after <after> Start after this cursor, from the previous page.
--limit <limit> How many to return.

JSON when stdout is not a terminal, failures as JSON on stderr, exit codes 0 to 6. Also takes the shared options below.

dexto cloud sandboxes create

Create a sandbox. Start it before running commands in it.

dexto cloud sandboxes create <name>
Option What it does
--size <size> The sandbox size; large (4 vCPU, 8 GiB) is the only one.

JSON when stdout is not a terminal, failures as JSON on stderr, exit codes 0 to 6. Also takes the shared options below.

dexto cloud sandboxes get

Show a sandbox.

dexto cloud sandboxes get <sandbox_id>

JSON when stdout is not a terminal, failures as JSON on stderr, exit codes 0 to 6. Also takes the shared options below.

dexto cloud sandboxes start

Start or resume a sandbox.

dexto cloud sandboxes start <sandbox_id>

JSON when stdout is not a terminal, failures as JSON on stderr, exit codes 0 to 6. Also takes the shared options below.

dexto cloud sandboxes pause

Pause a sandbox, keeping its workspace.

dexto cloud sandboxes pause <sandbox_id>

JSON when stdout is not a terminal, failures as JSON on stderr, exit codes 0 to 6. Also takes the shared options below.

dexto cloud sandboxes delete

Delete a sandbox and its workspace.

dexto cloud sandboxes delete <sandbox_id>
Option What it does
--yes Go ahead without being asked. Pass it only once your person has agreed.

JSON when stdout is not a terminal, failures as JSON on stderr, exit codes 0 to 6. Also takes the shared options below.

dexto cloud sandboxes exec

Run a shell command and print its output; exits with its exit code. Put -- before a command with options.

dexto cloud sandboxes exec <sandbox_id> <command...>
Option What it does
--cwd <cwd> The working directory (default /workspace).
--timeout <timeout> Milliseconds to wait, up to 120000 (default 60000).

JSON when stdout is not a terminal, failures as JSON on stderr, exit codes 0 to 6. Also takes the shared options below.

dexto cloud sandboxes ls

List a sandbox directory (default /workspace).

dexto cloud sandboxes ls <sandbox_id> [path]
Option What it does
--depth <depth> Levels to list (default 1).

JSON when stdout is not a terminal, failures as JSON on stderr, exit codes 0 to 6. Also takes the shared options below.

dexto cloud sandboxes cat

Print a UTF-8 sandbox file of up to 1 MiB.

dexto cloud sandboxes cat <sandbox_id> <path>

JSON when stdout is not a terminal, failures as JSON on stderr, exit codes 0 to 6. Also takes the shared options below.

dexto cloud sandboxes write

Write a UTF-8 sandbox file of up to 1 MiB from stdin or --from.

dexto cloud sandboxes write <sandbox_id> <path>
Option What it does
--from <from> Read the content from this local file instead of stdin.
--parents Create missing directories.

JSON when stdout is not a terminal, failures as JSON on stderr, exit codes 0 to 6. Also takes the shared options below.

dexto cloud sandboxes rm

Delete a sandbox file.

dexto cloud sandboxes rm <sandbox_id> <path>
Option What it does
--yes Go ahead without being asked. Pass it only once your person has agreed.

JSON when stdout is not a terminal, failures as JSON on stderr, exit codes 0 to 6. Also takes the shared options below.

dexto cloud sandboxes import

Copy project files into a sandbox.

dexto cloud sandboxes import <sandbox_id> <file_id...>
Option What it does
--dir <dir> The sandbox directory to copy into (default /workspace).

JSON when stdout is not a terminal, failures as JSON on stderr, exit codes 0 to 6. Also takes the shared options below.

dexto cloud sandboxes export

Save a sandbox file as a project file.

dexto cloud sandboxes export <sandbox_id> <sandbox_path> <file_path>
Option What it does
--overwrite Replace a project file at file_path.

JSON when stdout is not a terminal, failures as JSON on stderr, exit codes 0 to 6. Also takes the shared options below.

Shared options

Commands on this page that follow the JSON contract take these.

Option What it does
--api-base-url <api-base-url> The API origin (default https://api.dexto.ai, or DEXTO_API_BASE_URL).
--api-key <api-key> Use this key instead of DEXTO_API_KEY or the saved sign-in.
--profile <profile> The saved sign-in to use for this run (or DEXTO_PROFILE); see dexto accounts list.
--project <project> The Cloud project to act in when you're signed in (or DEXTO_CLOUD_PROJECT).
--json Print JSON, failures included (on stderr). The default when stdout isn't a terminal.
--table Print tables for people even when stdout isn't a terminal.