GETTING STARTED

CLI Pairing Guide

Follow this step-by-step guide to pair your terminal with Microbix services securely using our Device Code flow.

1. Prerequisites

2. Install the CLI

Install the Microbix CLI globally using npm:

Terminal
npm install -g @microbix/cli

3. Start the Pairing Process

Run the pairing command to initiate the Device Code authentication flow:

Terminal
aether pair

The CLI will display an 8-character device code and a URL.

4. Complete the Device Code Flow

  1. Open the provided URL in your browser.
  2. Log in to your Microbix account if prompted.
  3. Enter the 8-character device code displayed in your terminal.
  4. Approve the connection request.

5. Verify the Connection

Once approved, your terminal will automatically detect the success and save your secure token. You can verify it's working by running:

Terminal
aether whoami

Troubleshooting

If you encounter issues during pairing: