Install the CLI
- Sign in with GitHub in your browser.
- Optionally choose repositories for Box to use. You can skip this and add repositories later.
- Start the base plan in Stripe Checkout. It includes a free-of-charge 7-day trial.
- Return to the terminal while the CLI waits for billing to become active.
Create your first box
Programmatic use
Use the--json flag on any command to automate the Box CLI from scripts. See Use in Code.
Building Box into a product, CI system, hosted worker, or agent platform? Use the HTTP API to create or resume a Box, prompt it, observe events, return a desktop or app preview URL, then stop, resume, fork, or delete the Box according to your product lifecycle.
API guide
Learn auth, response envelopes, errors, lifecycle loops, agent prompts, desktop links, and OpenAPI reference usage.
OpenAPI reference
Explore generated endpoint docs for creating, prompting, observing, stopping, resuming, and forking boxes.
Use in Code
Script the CLI with JSON output when a shell integration is the fastest path.
.env files, and other runtime secrets, configure Dashboard > Secrets before running setup scripts in a Box.
For a long uninterrupted workflow, disable auto-stop when creating the Box:
Next steps
Machine Capabilities
See the runtimes, tools, desktop, and machine specs included in each Box.
Repositories
Choose which GitHub repositories Box clones into new VMs.
Secrets & Setup
Configure secrets, run setup scripts, and restart services after resume or fork.
Long-Running Tasks
Keep a Box running longer and restart runtime processes after resume or fork.
SSH Access
Connect to a Box over SSH from your terminal or external tools.
Desktop Streaming
Open the Box desktop and use Lux for browser or GUI automation.
Hosting
Expose a service running inside a Box on a public HTTPS URL.
Use in Code
Wrap the Box CLI from scripts and applications with JSON output.