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
-
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
You can authenticate using your password or an authentication token.
Password authentication
-
To log in with your email, run:
avn user login EMAIL_ADDRESS
-
When prompted, enter your password.
Token authentication
-
Create an authentication token.
-
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.
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.