Sandbox CLI Reference
Last updated November 7, 2025
The Sandbox CLI, based on the Docker CLI, allows you to manage sandboxes, execute commands, copy files, and more from your terminal. This page provides a complete reference for all available commands.
Use the CLI for manual testing and debugging, or use the SDK to automate sandbox workflows in your application.
Install the Sandbox CLI globally to use all commands:
Log in to use Vercel Sandbox:
Get help information for all available sandbox commands:
Description: Interfacing with Vercel Sandbox
Available subcommands:
- : List all sandboxes for the specified account and project. [alias: ]
- : Create a sandbox in the specified account and project.
- : Copy files between your local filesystem and a remote sandbox [alias: ]
- : Execute a command in an existing sandbox
- : Stop one or more running sandboxes [aliases: , ]
- : Create and run a command in a sandbox
- : Log in to the Sandbox CLI
- : Log out of the Sandbox CLI
For more help, try running sandbox <subcommand> --help
List all sandboxes for the specified account and project.
| Option | Alias | Description |
|---|---|---|
| - | Your Vercel authentication token. If you don't provide it, we'll use a stored token or prompt you to log in. | |
| - | The project name or ID you want to use with this command. | |
| The team you want to use with this command. |
| Flag | Short | Description |
|---|---|---|
| Show all sandboxes, including stopped ones (we only show running ones by default). | ||
| Display help information. |
Create and run a command in a sandbox.
| Option | Alias | Description |
|---|---|---|
| - | Your Vercel authentication token. If you don't provide it, we'll use a stored token or prompt you to log in. | |
| - | The project name or ID you want to use with this command. | |
| The team you want to use with this command. | ||
| - | Choose between Node.js ('node22') or Python ('python3.13'). We'll use Node.js by default. | |
| - | How long the sandbox can run before we automatically stop it. Examples: '5m', '1h'. We'll stop it after 5 minutes by default. | |
| Make a port from your sandbox accessible via a public URL. | ||
| Set the directory where you want the command to run. | ||
| Set environment variables for your command. |
| Flag | Short | Description |
|---|---|---|
| - | Run the command with admin privileges. | |
| Run the command in an interactive shell. | ||
| Enable terminal features for interactive commands. | ||
| - | Automatically delete the sandbox when the command finishes. | |
| Display help information. |
| Argument | Description |
|---|---|
| The command you want to run. | |
| Additional arguments for your command. |
Create a sandbox in the specified account and project.
| Option | Alias | Description |
|---|---|---|
| - | Your Vercel authentication token. If you don't provide it, we'll use a stored token or prompt you to log in. | |
| - | The project name or ID you want to use with this command. | |
| The team you want to use with this command. | ||
| - | Choose between Node.js ('node22') or Python ('python3.13'). We'll use Node.js by default. | |
| - | How long the sandbox can run before we automatically stop it. Examples: '5m', '1h'. We'll stop it after 5 minutes by default. | |
| Make a port from your sandbox accessible via a public URL. |
| Flag | Short | Description |
|---|---|---|
| - | Create the sandbox without showing you the sandbox ID. | |
| Display help information. |
Execute a command in an existing sandbox.
| Option | Alias | Description |
|---|---|---|
| - | Your Vercel authentication token. If you don't provide it, we'll use a stored token or prompt you to log in. | |
| - | The project name or ID you want to use with this command. | |
| The team you want to use with this command. | ||
| Set the directory where you want the command to run. | ||
| Set environment variables for your command. |
| Flag | Short | Description |
|---|---|---|
| - | Run the command with admin privileges. | |
| Run the command in an interactive shell. | ||
| Enable terminal features for interactive commands. | ||
| Display help information. |
| Argument | Description |
|---|---|
| The ID of the sandbox where you want to run the command. | |
| The command you want to run. | |
| Additional arguments for your command. |
Stop one or more running sandboxes.
| Option | Alias | Description |
|---|---|---|
| - | Your Vercel authentication token. If you don't provide it, we'll use a stored token or prompt you to log in. | |
| - | The project name or ID you want to use with this command. | |
| The team you want to use with this command. |
| Flag | Short | Description |
|---|---|---|
| Display help information. |
| Argument | Description |
|---|---|
| The ID of the sandbox you want to stop. | |
| Additional sandbox IDs to stop. |
Copy files between your local filesystem and a remote sandbox.
| Option | Alias | Description |
|---|---|---|
| - | Your Vercel authentication token. If you don't provide it, we'll use a stored token or prompt you to log in. | |
| - | The project name or ID you want to use with this command. | |
| The team you want to use with this command. |
| Flag | Short | Description |
|---|---|---|
| Display help information. |
| Argument | Description |
|---|---|
| The source file path (either a local file or sandbox_id:path for remote files). | |
| The destination file path (either a local file or sandbox_id:path for remote files). |
Log in to the Sandbox CLI.
| Flag | Short | Description |
|---|---|---|
| Display help information. |
Log out of the Sandbox CLI.
| Flag | Short | Description |
|---|---|---|
| Display help information. |
Was this helpful?