Quick Start Guide
Get up and running with the ScaleBox CLI in minutes. This guide covers the essential commands and workflows to help you manage templates and sandboxes effectively.
Get up and running with the ScaleBox CLI in minutes. This guide covers the essential commands and workflows to help you manage templates and sandboxes effectively.
⚡ Prerequisites
Make sure you have a ScaleBox account and API key. You can get your API key from the dashboard.
Table of Contents
Getting Started
Follow these steps to get the ScaleBox CLI set up and ready to use:
Step 1: Install ScaleBox CLI
Download the appropriate binary for your platform and add to PATH.
| Platform | Architecture | Size | Download |
|---|---|---|---|
| Linux x86_64 | For most Linux servers and desktops | 15MB | Download |
| Linux ARM64 | For Raspberry Pi, AWS Graviton, Apple Silicon Linux | 14MB | Download |
| macOS Intel | For Intel-based Mac computers | 15MB | Download |
| macOS Apple Silicon | For M1/M2/M3 Mac computers | 15MB | Download |
| Windows x86_64 | For Windows 10/11 systems | 16MB | Download |
Step 2: Authenticate with API Key
Login using your ScaleBox API key.
scalebox-cli auth login --api-key sk-your-key --server-url https://api.scalebox.devStep 3: Explore Available Templates
List public and your private templates.
scalebox-cli template listStep 4: Create Your First Sandbox
Launch a sandbox from a template.
scalebox-cli sandbox create --template tpl-abc123 --name my-workspaceCommon Workflows
Working with Templates
- Browse available templates:
scalebox-cli template list- Get detailed template information:
scalebox-cli template get tpl-xmmk6trfpg6mv3h9u- Update template properties:
scalebox-cli template update tpl-abc123 --description "Updated template description"Managing Sandboxes
- Create a new sandbox:
scalebox-cli sandbox create --template tpl-xmmk6trfpg6mv3h9u --name my-workspace- List your sandboxes:
scalebox-cli sandbox list- Get sandbox connection details:
scalebox-cli sandbox get sbx-abc123def456789Advanced Operations
- Export Docker image for replacement:
docker save my-updated-app:latest -o my-app-v2.0.tar- Update template properties:
scalebox-cli template update tpl-xmmk6trfpg6mv3h9u --description "Updated template description"Essential Commands Cheat Sheet
Quick reference for the most commonly used commands:
Templates
| Task | Command |
|---|---|
| List all available templates | scalebox-cli template list |
| Get template details | scalebox-cli template get tpl-abc123def456789 |
Sandboxes
| Task | Command |
|---|---|
| Create a new sandbox | scalebox-cli sandbox create --template tpl-abc123 --name my-project |
| List your sandboxes | scalebox-cli sandbox list |
| Get sandbox details and connection info | scalebox-cli sandbox get sbx-def456ghi789012 |
Authentication
| Task | Command |
|---|---|
| Check authentication status | scalebox-cli auth whoami |
| View current user info | scalebox-cli auth whoami |
Files
| Task | Command |
|---|---|
| Upload file to sandbox (v1.2.2) | scalebox-cli sandbox upload sbx-def456 ./data.json /workspace/data.json |
| Download files from sandbox (v1.2.2) | scalebox-cli sandbox download sbx-def456 /workspace/results /local/results --recursive |
| List sandbox directory contents (v1.2.2) | scalebox-cli sandbox ls sbx-def456 /workspace/project |
Next Steps
Now that you're familiar with the basics, explore these resources:
Template Commands
Complete reference for all template management commands and options.
Sandbox Commands
Learn about sandbox lifecycle management and monitoring commands.
Automation
Integrate the CLI into your scripts and CI/CD pipelines.
🎉 You're all set!
You now know the essential ScaleBox CLI commands. Need help? Check the command-line help with scalebox-cli --help or scalebox-cli [command] --help for detailed information about any command.
CLI Authentication
Learn how to authenticate the ScaleBox CLI with your API key to securely access templates, sandboxes, and projects. The CLI supports multiple authentication methods including environment variables, command flags, and interactive prompts.
Template Commands
Complete reference for managing environment templates using the ScaleBox CLI. Templates define the base images and configurations used to create sandbox environments.