bluectl

bluectl is the official command line interface (CLI) for Alphaus services.

Installation

You can install bluectl using Homebrew (MacOS, Linux, and Windows through WSL/2). Run the command below in a terminal:

$ brew install alphauslabs/tap/bluectl

Usage

bluectl uses API client credentials for authentication. You can generate your API credentials either from Ripple under "Tools > API Access Tokens", or Wave(Pro) under "Settings > API Access Tokens".

To validate your credentials with bluectl, run the command below (replace the {client-*} part with your actual client id and client secret values):

$ bluectl whoami --client-id {client-id} --client-secret {client-secret}

If successful, it will output some information about the authenticated user.

You can also store your credentials as environment variables instead of typing them everytime you run a command. Check out the "Environment setup" section here.

With environment variables set, you should now be able to run any bluectl commands without the --client-id and --client-secret flags.

$ bluectl whoami

Finally, explore other available commands by running:

# Check out the main commands:
$ bluectl -h

# More information on a specific subcommand:
$ bluectl {subcommand} -h