# Overview

The BH CLI is a command-line interface tool that allows you to interact with the BH platform from your terminal. It provides various commands to make it easier to directly dispatch the scan, download job artifacts, blobs, and more without having to use the browser.

To learn more about what BH does, visit the Commands page.

# Installation

You can install the BH CLI in various ways.

# Using cargo

If you have Rust and Cargo installed, you can install the BH CLI using the following command:

bash

# From the source

You can also build the BH CLI from the source code. First, clone the repository:

bash

Then, build the BH CLI using Cargo:

bash

# Downloading pre-built binaries

You can download pre-built binaries for your operating system from the releases page. Choose the appropriate binary for your OS, download it, and add it to your system's PATH.

# Configuration

Before using the BH CLI, you need to configure it with your BH API token. You can obtain your API token from your BountyHub profile settings.

When there, you have to provision the new Personal Access Token with the required scopes. More about Personal Access Tokens can be found on Developer Overview page, while scopes you can configure can be found on the Developer Scopes page.

Once the Personal Access Token (PAT) is created, you can add it as an environment variable.

For example, if you are using bash, you can add the following line to your ~/.bashrc file:

bash

To leverage the command completion, you can replace the <shell> placeholder with your shell type (e.g., bash, zsh, fish). You can also add this line to your shell configuration file (e.g., ~/.bashrc, ~/.zshrc, etc:

bash

# Next steps

  • BH Commands: Explore the various commands available in the BH CLI to interact with the BountyHub platform.
  • Developer Overview: Learn more about BountyHub's developer features, including API usage and integration options.