Blaxel CLI

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

Install

Install on Mac

To install Blaxel CLI, you must use Homebrew: make sure it is installed on your machine. 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 two following commands successively in a terminal:

brew tap blaxel-ai/blaxel

brew install blaxel

Install on Linux

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

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

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

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

Install with cURL

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

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

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

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

Install on Windows

Update

Update on Mac

To update Blaxel CLI, you must use Homebrew: make sure it is installed on your machine. We are currently in the process of supporting additional installers. Check out the cURL method down below for general installation.

brew upgrade blaxel

Update on Linux

Update Blaxel CLI by running the following command in a terminal (alternatives below):

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

If you need to specify a version (e.g. 0.1.21):

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

Update with cURL

Update Blaxel CLI by running the following command in a terminal (alternatives below):

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

If you need to specify a version (e.g. 0.1.21):

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

Update on Windows

Get started

To get started with Blaxel CLI, your must first create a workspace on the Blaxel console. Then, login to Blaxel using this command. Find your workspace ID in the top left sidebar corner of Blaxel Console:

bl login <<WORKSPACE-ID>>

You will be prompted to finish login using either an API key, or through your browser.

Set a workspace to use as a context for the session by using the following command:

bl workspaces your-workspace

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

You can now run any command to interact with Blaxel resources in your workspace. For example, to list agents:

bl get agents

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

Overview

Authentication API

Developer API

Inference API

Management API

Tools

Install

Update

Get started

Options

Overview

Authentication API

Developer API

Inference API

Management API

Tools

​Install

​Update

​Get started

​Options

Install

Update

Get started

Options