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:
Copy
Ask AI
brew tap blaxel-ai/blaxel
Copy
Ask AI
brew install blaxel
Install on Linux
Install Blaxel CLI by running the following command in a terminal (non-sudo alternatives below):
Copy
Ask AI
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):
Copy
Ask AI
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):
Copy
Ask AI
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):
Copy
Ask AI
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):
Copy
Ask AI
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):
Copy
Ask AI
curl -fsSL \https://raw.githubusercontent.com/blaxel-ai/toolkit/main/install.sh \| VERSION=v0.1.21 sh
Install on Windows
For the most reliable solution, we recommend adapting the aforementioned Linux commands by using Windows Subsystem for Linux.First install WSL (Windows Subsystem for Linux) if not already installed. 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.
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.
Copy
Ask AI
brew upgrade blaxel
Update on Linux
Update Blaxel CLI by running the following command in a terminal (alternatives below):
Copy
Ask AI
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:
Copy
Ask AI
curl -fsSL \https://raw.githubusercontent.com/blaxel-ai/toolkit/main/install.sh \| sh
If you need to update to a specific version (e.g. v0.1.21):
Copy
Ask AI
curl -fsSL \https://raw.githubusercontent.com/blaxel-ai/toolkit/main/install.sh \| VERSION=v0.1.21 sh
Update with cURL
Update Blaxel CLI by running the following command in a terminal (non-sudo alternatives below):
Copy
Ask AI
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:
Copy
Ask AI
curl -fsSL \https://raw.githubusercontent.com/blaxel-ai/toolkit/main/install.sh \| sh
If you need to update to a specific version (e.g. v0.1.21):
Copy
Ask AI
curl -fsSL \https://raw.githubusercontent.com/blaxel-ai/toolkit/main/install.sh \| VERSION=v0.1.21 sh
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.
To get started with Blaxel CLI, your must first create a workspace on the Blaxel console. Then, login to Blaxel using this command:
Copy
Ask AI
bl login
In case you have multiple workspaces, the one you logged in to will be used automatically in every command you used with our CLI.You can login to as much workspace as you wantTo set your context to a different workspace you already logged in to, use the following command:
Copy
Ask AI
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:
-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