Install the Astra CLI

Install the Astra CLI to create and manage Astra DB databases and Astra Streaming tenants from the command line.

Supported platforms

The Astra CLI supports the following operating systems:

Operating System Architecture

Linux

x86_64, arm64

macOS

x86_64, arm64

Microsoft Windows

x86_64

To install the Astra CLI on macOS and Linux, you can use a scripted installation, binary installation, or a package manager.

Run the following command to install the latest version of the Astra CLI to the default location:
```
curl -sSL https://ibm.biz/astra-cli | sh
```
To install the Astra CLI to a custom location, export the ASTRA_HOME environment variable before running the installation command, replacing INSTALLATION_DIRECTORY with the full path to your preferred installation directory:
```
export ASTRA_HOME=INSTALLATION_DIRECTORY
```
Add the astra executable to your PATH by running the command supplied after installation:
```
echo 'eval "$(~/.astra/cli/astra shellenv)"' >> ~/.zprofile
```
Reload your shell profile or open a new terminal window.
Run the astra command from any directory to verify successful installation:
```
astra
```
The response includes available commands and options for the Astra CLI.

Download the appropriate binary archive for your OS and CPU architecture from GitHub.
Extract the archive into the directory where you want to install the Astra CLI. For example:
```
sudo tar -xzvf astra-OS-ARCHITECTURE.tar.gz -C INSTALLATION_DIRECTORY
```
Replace the following:
- OS: Your operating system (macos or linux).
- ARCHITECTURE: Your CPU architecture (x86_64 or arm64).
- INSTALLATION_DIRECTORY: The full path to your preferred installation directory.
Add the following lines to your shell profile (for example, ~/.zprofile or ~/.bash_profile) to make the astra command executable from any directory:
```
# Astra CLI shell configuration
eval "$(PATH_TO_BINARY shellenv)"
```
Replace PATH_TO_BINARY with the full path to the astra executable in the installation directory.
On macOS: Delete the com.apple.quarantine attribute from the astra binary to remove macOS Gatekeeper restrictions:
```
xattr -d com.apple.quarantine $(which astra)
```
Alternatively, you can remove these restrictions in your macOS System Settings.

If you don’t remove the restrictions, you will receive a security alert stating "astra" Not Opened when you run the astra command.
Reload your shell profile or open a new terminal window.
Run the astra command from any directory to verify successful installation:
```
astra
```
The response includes available commands and options for the Astra CLI.

Install the latest version of the Astra CLI using Homebrew:
```
brew install datastax/astra-cli/astra
```
Run the astra command from any directory to verify successful installation:
```
astra
```
The response includes available commands and options for the Astra CLI.

To install the Astra CLI on Windows, you can use a scripted installation or binary installation.

Run the following command to install the latest version of the Astra CLI to the default location:
```
powershell -c "irm https://ibm.biz/astra-cli-win | iex"
```
To install the Astra CLI to a custom location, export the ASTRA_HOME environment variable before running the installation command, replacing INSTALLATION_DIRECTORY with the full path to your preferred installation directory:
```
$env:ASTRA_HOME = "INSTALLATION_DIRECTORY"
```
Open a new terminal window.
Run the astra command from any directory to verify successful installation:
```
astra
```
The response includes available commands and options for the Astra CLI.

Download the windows zip file from GitHub.
Extract the zip file into the directory where you want to install the Astra CLI:
```
powershell -C "Expand-Archive -Path astra-windows-x86_64.zip -DestinationPath INSTALLATION_DIRECTORY -Force"
```
Replace INSTALLATION_DIRECTORY with the full path to your preferred installation directory.
Add the path to the unzipped astra.exe file to your PATH environment variable. For more information, see the Microsoft PowerShell documentation.
Start a new PowerShell session by opening a new terminal window.
Run the astra command from any directory to verify successful installation:
```
astra
```
The response includes available commands and options for the Astra CLI.

To connect to Astra and run your first commands, see Connect and manage the Astra CLI.