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

1. The avn utility is a Python package:

   pip

   pip install aiven-client

   Homebrew

   brew install aiven-client

2. To check your installation, run:

   avn --version

Authenticate with the Aiven CLI

You can authenticate using your password or a token.

With a password

1. To log in with your email, run:

   avn user login EMAIL_ADDRESS

2. When prompted, enter your password.

With a token

1. Create a token.

2. To authenticate with a token, run:

   avn user login EMAIL_ADDRESS --token

note

If you are registered on Aiven through the AWS or GCP marketplace, use the --tenant option. For example:

avn user login EMAIL_ADDRESS --tenant aws

Configure the output format

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

Related pages

• 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.