Overview

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

Install

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. Please reach out to support@blaxel.ai if you need to use an alternative to Homebrew.

Install Blaxel CLI by running the two following commands successively in a terminal:


brew tap beamlit/blaxel

brew install blaxel

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

curl -fsSL \
https://raw.githubusercontent.com/beamlit/toolkit/main/install.sh \
| BINDIR=$HOME/.local/bin sh

If you need to specify a version:

curl -fsSL \
https://raw.githubusercontent.com/beamlit/toolkit/main/install.sh \
| VERSION=0.36.0 BINDIR=$HOME/.local/bin sh

If you need to use sudo:

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

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

curl -fsSL \
https://raw.githubusercontent.com/beamlit/toolkit/main/install.sh \
| BINDIR=$HOME/.local/bin sh

If you need to specify a version:

curl -fsSL \
https://raw.githubusercontent.com/beamlit/toolkit/main/install.sh \
| VERSION=0.36.0 BINDIR=$HOME/.local/bin sh

If you need to use sudo:

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

Get started

To get started with Blaxel CLI, your must first create a workspace on the Blaxel console. Then, login to Blaxel using the following command and replacing your-workspace:

bl login your-workspace

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

Authentication API

Developer API

Inference API

Management API

Tools

Overview

Install

Get started

Options

Overview

Authentication API

Developer API

Inference API

Management API

Tools

​Install

​Get started

​Options

Install

Get started

Options