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.

Get started

Install

  1. The avn utility is a Python package:

    pip install aiven-client
  2. To check your installation, run:

    avn --version

Authenticate

You can authenticate using your password or an authentication token.

Password authentication

  1. To log in with your email, run:

    avn user login EMAIL_ADDRESS
  2. When prompted, enter your password.

Token authentication

  1. Create an authentication token.

  2. To authenticate with a token, run:

    avn user login EMAIL_ADDRESS --token

Format output

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