ProAuth Documentation

Appearance

ProAuth CLI Installation ​

The ProAuth CLI is a command-line interface tool designed for administrators and DevOps engineers to automate tasks such as configuring the ProAuth server in pipeline automation or interacting with the API without using the Admin App frontend.

Installation ​

The ProAuth CLI is distributed as a .NET tool and can be installed using the .NET CLI:

bash
dotnet tool install ProAuth.Cli --global --configfile ~/nuget-config.config --version 2.1.0

TIP

We recommend using the same version for the CLI as your ProAuth product version. Always use the --version flag to ensure compatibility.

WARNING

The CLI is distributed through our private NuGet feed, which requires authentication.

Authentication Options ​

There are two ways to access the CLI package:

  1. Direct authentication to our feed: Use a NuGet config file with feed authentication details provided by us, as shown in the installation command.

  2. Internal package distribution: Alternatively, you can distribute the package through your internal feed with your own authentication settings.

Authentication settings for our private feed are provided to customers in the same way as access to the Docker registry.

Verification ​

Once the tool is installed, you can verify it's working by running:

bash
proauthcli --version

This should display the currently installed version of the CLI tool.

Next Steps ​

After installation, the CLI can be executed by calling proauthcli from your terminal. For detailed usage instructions, refer to the CLI Usage documentation.