rwx sandbox start
Start a sandbox without executing a command.
Usage
rwx sandbox start [config-file] [flags]
Description
Initializes and starts a sandbox session without running any command. This is useful for pre-building a sandbox environment so it's ready for subsequent exec commands.
Most of the time, thanks to RWX's content-based caching, it's fast enough to lazily start a sandbox when executing a command, but if you have complex environment setup (such as background processes that need to spin up), you may benefit from pre-starting sandboxes.
If you already have a sandbox running for your current branch and config file when you run rwx sandbox start, the CLI will confirm whether you want to use the existing one or stop it and start a new one.
Local uncommitted changes (staged, unstaged, and untracked files) are included in the sandbox when it starts, consistent with rwx run. This means setup tasks run against the same code that subsequent rwx sandbox exec calls will use.
Arguments
[config-file]
The path to the sandbox configuration file. Defaults to .rwx/sandbox.yml.
Options
-d, --dir <directory>
The directory your RWX configuration files are located in, typically .rwx. By default, the CLI traverses up until it finds a .rwx directory.
--id <run-id>
Use a specific run ID to target an existing sandbox session.
--open
Open the run in a browser after starting.
--wait
Wait for the sandbox to be ready before returning. Without this flag, the command returns immediately after initiating the start.
Global Options
--output <format>
Output format: text or json. Defaults to text.
--access-token <token>
The access token for RWX. Defaults to the value of the $RWX_ACCESS_TOKEN environment variable.