Blaxel CLI overview

Install the Blaxel CLI (bl) to manage sandboxes, agents, MCP servers, jobs, and other resources from your terminal, with auth and command reference.

Blaxel CLI (bl) is a command line tool to interact with the Blaxel APIs.

Install

Install on Mac

To install Blaxel CLI with Homebrew, make sure Homebrew is installed on your machine. Homebrew 6.0.0+ requires explicit trust for non-official taps, so use the fully qualified formula name below. We are currently in the process of supporting additional installers. Check out the cURL method down below for general installation.

Install Blaxel CLI by running the following command in a terminal:

brew install blaxel-ai/blaxel/blaxel

Install on Linux

Install Blaxel CLI by running the following command in a terminal (non-sudo alternatives below):

curl -fsSL \
https://raw.githubusercontent.com/blaxel-ai/toolkit/main/install.sh \
| BINDIR=/usr/local/bin sudo -E sh

If you need a non-sudo alternative (it will ask you questions to configure):

curl -fsSL \
https://raw.githubusercontent.com/blaxel-ai/toolkit/main/install.sh \
| sh

If you need to install a specific version (e.g. v0.1.21):

curl -fsSL \
https://raw.githubusercontent.com/blaxel-ai/toolkit/main/install.sh \
| VERSION=v0.1.21 sh

Install with cURL

Install Blaxel CLI by running the following command in a terminal (non-sudo alternatives below):

curl -fsSL \
https://raw.githubusercontent.com/blaxel-ai/toolkit/main/install.sh \
| BINDIR=/usr/local/bin sudo -E sh

If you need a non-sudo alternative (it will ask you questions to configure):

curl -fsSL \
https://raw.githubusercontent.com/blaxel-ai/toolkit/main/install.sh \
| sh

If you need to install a specific version (e.g. v0.1.21):

curl -fsSL \
https://raw.githubusercontent.com/blaxel-ai/toolkit/main/install.sh \
| VERSION=v0.1.21 sh

Install on Windows

Run the following command in PowerShell:

powershell -Command "irm https://raw.githubusercontent.com/blaxel-ai/toolkit/main/install.ps1 | iex"

Alternatively, you can use Windows Subsystem for Linux (WSL) and follow the Linux installation instructions.

Update

Update on Mac

Update Blaxel CLI by running the following command in a terminal:

bl upgrade

If you need to update to a specific version (e.g. v0.1.21):

bl upgrade --version 0.1.21

You can also upgrade using Homebrew:

brew upgrade blaxel

Update on Linux

Update Blaxel CLI by running the following command in a terminal:

bl upgrade

If you need to update to a specific version (e.g. v0.1.21):

bl upgrade --version 0.1.21

Update on Windows

For the most reliable solution, we recommend adapting the aforementioned Linux commands by using Windows Subsystem for Linux.

First make sure WSL (Windows Subsystem for Linux) is installed if not already. This can be done by:

• Opening PowerShell as Administrator
• Running: wsl --install -d Ubuntu-20.04
• Restarting the computer
• From the Microsoft Store, install the Ubuntu app
• Run the command line using the aforementioned Linux installation process. Make sure to install using sudo.

Shell autocompletion

To enable shell autocompletion for Blaxel CLI commands, run one of the following:

zsh

echo 'eval "$(bl completion zsh)"' >> ~/.zshrc

echo 'eval "$(bl completion bash)"' >> ~/.bashrc

echo 'bl completion fish' > ~/.config/fish/completions/bl.fish

if (!(Test-Path -Path $PROFILE)) {
New-Item -ItemType File -Path $PROFILE -Force
}
Add-Content -Path $PROFILE -Value '(& bl completion powershell) | Out-String | Invoke-Expression'

Get started

First, create a workspace on the Blaxel console. Then, login to Blaxel:

bl login

If you have multiple workspaces, the one you last logged into will be used automatically in every subsequent command you run. You can login to as many workspaces as you want.

To set your context to a different workspace you already logged in to, use the following command:

bl workspaces your-workspace

### You can retrieve the list of all your workspaces by running:
bl workspaces

Basic commands to scaffold, develop, and deploy your resources:

Command	Purpose
bl new	Scaffold a new local project (code + blaxel.toml)
bl deploy	Build image + push image + create/update resource + watch logs
bl push	Build image + push image to Blaxel registry (no resource created or updated)
bl apply	Declarative resource creation/update using YAML files, similar to kubectl apply
bl serve	Local execution (not available for sandboxes)

bl deploy is an all-in-one command that packages local files into an image, pushes it as a template, and deploys it as a resource on Blaxel. Use the --skip-build flag to skip image rebuilding. Use bl push instead to only build and push the image.

Interact with existing resources in your workspace:

bl get sandboxes

Options

-h, --help               Get the help for Blaxel
-w, --workspace string   Specify the Blaxel workspace to work on.
-o, --output string      Output format. One of: pretty, yaml, json, table
-v, --verbose            Enable verbose output