Skip to content

How to install ABP CLI ?

ABP CLI (Command Line Interface) is a command line tool to perform some common operations for ABP based solutions.

ABP CLI installation

ABP CLI is a dotnet global tool. Install it using a command line window:

dotnet tool install -g Volo.Abp.Studio.Cli

For specific version e.g. 0.9.0. Replace version number with latest available.

dotnet tool install -g Volo.Abp.Studio.Cli --version 0.9.0

To update an existing installation:

dotnet tool update -g Volo.Abp.Studio.Cli

ABP CLI has two variations, which are Volo.Abp.Studio.Cli (new) and Volo.Abp.Cli (old). If you are using ABP earlier than v8.2+, then you are probably using the old ABP CLI and can easily switch to the new CLI by simply uninstalling the old one and installing the new CLI by executing the commands below:

# uninstalling the old CLI
dotnet tool uninstall -g Volo.Abp.Cli

# installing the new CLI
dotnet tool install -g Volo.Abp.Studio.Cli

ABP login

Make sure you have logged in to abp.io via ABP CLI. If you are not logged in

login

Some features of the CLI requires to be logged in to abp.io platform. To login with your username write:

abp login <username>                                  # Allows you to enter your password hidden
abp login <username> -p <password>                    # Specify the password as a parameter (password is visible)
abp login <username> --organization <organization>    # If you have multiple organizations, you need set your active organization
abp login <username> -p <password> -o <organization>  # You can enter both your password and organization in the same command
abp login <username> --device                         # Use device login flow

When using the -p parameter, be careful as your password will be visible. It's useful for CI/CD automation pipelines.

A new login with an already active session overwrites the previous session.

login-info

Shows your login information such as Name, Surname, Username, Email Address and Organization.

abp login-info

logout

Logs you out by removing the session token from your computer.

abp logout