bi-cli

$${\color{red}\textbf{WARNING: This tool is in alpha. Expect breaking changes.}}$$

Official Beyond Identity command-line interface.

Table of Contents

1. Installation

• macOS and Linux
  • Install Script
  • Manual Installation
• Windows
  • Using Scoop
  • Manual Installation

2. Usage

Installation

macOS and Linux

Install Script

You can install bi using the provided install.sh script.

Using cURL

Open your terminal and run:

curl -fsSL https://raw.githubusercontent.com/gobeyondidentity/bi-cli/main/install.sh | sh

Using wget

If you prefer wget, run:

wget -qO- https://raw.githubusercontent.com/gobeyondidentity/bi-cli/main/install.sh | sh

Manual Installation (macOS and Linux)

Step-by-step Instructions

If you prefer to install bi manually:

1. Download the Binary:

• Visit the Releases page.
• Download the latest release for your operating system and architecture (arm64 or x86_64).

2. Extract the Binary:

• Extract the contents of the tarball to a directory of your choice.

3. Make the Binary Executable:

• Open your terminal and navigate to the download directory.

• Run:

  chmod +x bi

4. Move the Binary to a Directory in your PATH:

• For example:

  sudo mv bi /usr/local/bin/

5. Verify the Installation:

• Run:

  bi --version

  to confirm that bi is installed and accessible from your terminal.

Windows

Using Scoop

You can install bi on Windows using Scoop, a command-line installer for Windows.

1. Add the bi Bucket:

scoop bucket add bi https://github.com/gobeyondidentity/bi-cli.git

2. Install bi:

scoop install bi

3. Verify the Installation:

bi --version

Manual Installation (Windows)

Step-by-step Instructions

1. Download the Executable:

• Go to the Releases page.
• Download the latest Windows release for your architecture (arm64 or x86_64).

2. Extract the Binary:

• Unzip the downloaded file to a directory of your choice (e.g., C:\Program Files\bi).

3. Add to PATH (Optional but Recommended):

• Press Win + X and select System.
• Click on Advanced system settings.
• Click Environment Variables.
• Under System variables, scroll to Path and click Edit.
• Click New and add the path to your bi executable (e.g., C:\Program Files\bi).
• Click OK to close all dialogs.
• Restart Command Prompt or PowerShell to ensure changes take effect.

4. Run bi:

• Open Command Prompt or PowerShell.

• If you didn't add bi to your PATH, navigate to the directory containing bi.exe.

• Run:

  .\bi.exe --version

• If you added bi to your PATH, simply run:

  bi --version

Usage

For detailed usage instructions, see Command Line Help.

Local Database Management

The following are the locations of the local database

MacOs

/Users/<localuser>/Library/Application Support/com.BeyondIdentity.bi

Linux

/home/<localuser>/.config/bi

Windows

C:\Users\<localuser>\AppData\Roaming\BeyondIdentity\bi