Installing Toolbelt

Toolbelt provides a command line interface to the Aunsight platform that enables interaction with Aunsight without the need to launch a web browser. Because it can be integrated in shell scripts, Toolbelt also extends the productivity of engineers by allowing them to automate maintenance tasks and even deploy those tasks within Docker container processes.

This article details how to install the Aunsight toolbelt on Mac or Linux and Windows systems. After reading this article, users will have a working Toolbelt interface accessible from their system shell. From there, users may wish to learn more about the commands Toolbelt exposes to users.

Step 1: Download

Download the latest toolbelt version for Mac, Windows, or Linux at: https://artifacts.aunalytics.com/toolbelt/Toolbelt-latest/

From the directory, download the appropriate version for your operating system.

Step 2: Installing

MacOS and Linux

  1. Set the executable bit for the file: chmod +x ./aunsight-toolbelt2-macos (MacOS) or chmod +x ./aunsight-toolbelt2-linux (Linux)
  2. Move the downloaded file to a directory in your $PATH environment variable. Assuming your download is located in~/Downloads/, use the following command:

mv ~/Downloads/aunsight-toolbelt2-macos /usr/local/bin/au2

Note

It is recommended that you rename your file au2 rather than relying on shell aliases. This way you can invoke toolbelt by typing au2 in all shells, rather than relying on shell configuration files.

Windows

  1. Rename the downloaded file from aunsight-toolbelt2-win.exe to au2.exe.
  2. Move au2.exe to a location you would like to install it. (e.g. c:\Program Files\toolbelt\). Any directory will do so long as it can safely be included in your Path environment variable (e.g. Not a folder like c:\Users\<username>\Downloads\)
  3. Add the location of au2.exe to your Path environment variable. To learn how to do this, see Microsoft's documentation.

Step 3: Verifying the Installation

To check if toolbelt is installed correctly, restart your shell session and type:

au2 --version

This should display the current version of the au2 (Toolbelt) command line interface.

To verify that toolbelt can communicate with the Aunsight remote services, type:

au2 login

You will be prompted for your Aunsight credentials. If you receive a token back after you've successfully logged in, then Toolbelt has successfully been installed.

Note

You do not need to manually save the token you receive; Toolbelt automatically manages Aunsight tokens.