Installation

Download and install the ScaleBox CLI to manage templates and sandboxes from the command line. Available for Linux, macOS, and Windows with native binaries and no dependencies.

✨ Latest release: ScaleBox CLI v1.4.9

v1.4.9 — auth logout removes only the active credential profile; other saved profiles remain.
v1.4.8 — Browser-login CLI credentials now work consistently across template, sandbox, and Harbor-backed workflows.
v1.4.7 — STS session_token support in --object-storage (create and resume), --best-effort-oss on resume, sandbox get shows mount metadata including short_lived.
v1.4.6 — sandbox resume --object-storage applies an OSS delta when resuming a single paused sandbox (add/update/delete/disable mounts; not supported with batch resume).
v1.4.5 — template build --external-image-url validates registry URL and optional --username / --password before local pull. template import is remote-only (backend copy job); use template build when you have Docker locally.
v1.4.4 — Browser login now issues dedicated CLI credentials (sb-cli-...) separate from console API keys. Each browser login refreshes the token for the active profile; manual --api-key login is unchanged.
v1.4.3 — fixed the template build shorthand conflict that caused the command to panic, and corrected stale template help text around ports and delete behavior.
v1.4.2 — renamed the top-level authenticated-user command from profile to user to avoid confusion with auth profile. user change-password remains documented separately from the email reset flow, including the requirement that the submitted new password differ from the submitted current password.
v1.3.8 — sandbox run-code and sandbox run-code-context call the agent Jupyter ExecutionService (advanced; use on code-interpreter or templates derived from it; see scalebox-cli sandbox run-code --help). On other templates use sandbox exec for shell commands.
v1.3.7 — sandbox create --async exits after the API accepts the create (no CLI polling); use scalebox-cli sandbox get <id> for status. --no-terminal skips the interactive terminal after a sync create reaches running (CI/scripts).
v1.3.6 — template document subcommands (get, download, set, clear) for long-form Markdown template docs.
v1.3.5 — sandbox regions, locality on create, inline JSON for --object-storage and --ports. Earlier: template build --image-file, WebRTC TURN, port management.

Platform Downloads
Installation Verification
Shell Completion
Quick Setup
System Requirements
Security Verification

Platform Downloads

Choose the appropriate binary for your platform. All binaries are statically compiled and require no additional dependencies.

Platform	Architecture	Size	Download
Linux x86_64	For most Linux servers and desktops	16MB	Download
Linux ARM64	For Raspberry Pi, AWS Graviton, Apple Silicon Linux	15MB	Download
macOS Intel	For Intel-based Mac computers	16MB	Download
macOS Apple Silicon	For M1/M2/M3 Mac computers	15MB	Download
Windows x86_64	For Windows 10/11 systems	16MB	Download

All binaries are statically compiled and require no additional dependencies.

Installation Verification

After installation, verify that the CLI is working correctly:

1. Check Version

scalebox-cli --version

Expected output: scalebox-cli version 1.4.9 (commit: dev, built: unknown)

2. View Help

scalebox-cli --help

Shell Completion

The CLI can generate completion scripts for bash, zsh, fish, and powershell.

Bash (current shell)

source <(scalebox-cli completion bash)

PowerShell (current session)

scalebox-cli completion powershell | Out-String | Invoke-Expression

You can also print scripts for zsh and fish with scalebox-cli completion zsh and scalebox-cli completion fish.

Quick Setup

Get started with the ScaleBox CLI in just a few commands:

1. Authenticate with your API key

scalebox-cli auth login --api-key your-api-key --server-url https://api.scalebox.dev

Replace your-api-key with your actual API key from the dashboard.

2. List available templates

scalebox-cli template list

3. Create your first sandbox

scalebox-cli sandbox create --template tpl-abc123

System Requirements

Minimum Requirements

Operating Systems

Linux (glibc 2.17+)
macOS 10.12+
Windows 10+

Dependencies

Docker (for image operations)
HTTPS network access
~50MB disk space

Security Verification

Verify the integrity of downloaded binaries using SHA256 checksums:

Download Checksums

Download checksums.txt

Pin this release: checksums-v1.4.9.txt

Verify on Linux/macOS

sha256sum -c checksums.txt

Ready to get started?

Continue to the Authentication Guide to learn how to connect to your ScaleBox instance, or check out the Quick Start Guide for common workflows.