Overview
Blaxel CLI
Interact with Blaxel through a command line interface.
Blaxel CLI is a command line tool to interact with the Blaxel APIs.
Install Blaxel CLI by running the two following commands successively in a terminal:
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 want
To set your context to a different workspace you already logged in to, use the following command:
You can now run any command to interact with Blaxel resources in your workspace. For example, to list agents:
Install
Install on Mac
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 on Linux
Install on Linux
Install Blaxel CLI by running the following command in a terminal (non-sudo alternatives below):If you need a non-sudo alternative (it will ask you questions to configure):If you need to install a specific version (e.g. v0.1.21):
Install with cURL
Install with cURL
Install Blaxel CLI by running the following command in a terminal (non-sudo alternatives below):If you need a non-sudo alternative (it will ask you questions to configure):If you need to install a specific version (e.g. v0.1.21):
Install on Windows
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.
Update
Update on Mac
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.
Update on Linux
Update on Linux
Update Blaxel CLI by running the following command in a terminal (alternatives below):If you need a non-sudo alternative:If you need to update to a specific version (e.g. v0.1.21):
Update with cURL
Update with cURL
Update Blaxel CLI by running the following command in a terminal (non-sudo alternatives below):If you need a non-sudo alternative:If you need to update to a specific version (e.g. v0.1.21):
Update on Windows
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.