Skip to main content

Aiven CLI

The Aiven command line interface (CLI) lets you use the Aiven platform and services in a scriptable way through the API.

Install the Aiven CLI

The avn utility is a Python package:

pip
Homebrew

pip install aiven-client

brew install aiven-client

To check your installation, run:
```
avn --version
```

Authenticate with the Aiven CLI

You can authenticate using your password or a token.

With a password
With a token

To log in with your email, run:
```
avn user login EMAIL_ADDRESS
```
When prompted, enter your password.

Create a token.
To authenticate with a token, run:
```
avn user login EMAIL_ADDRESS --token
```

Configure the output format

To get information in JSON format, use the --json switch with any command.

Learn how to use the Aiven CLI for common tasks.
Watch the how to get started tutorial.
Go to the aiven-client repository on GitHub.