CLI

Overview

The Bigeye-CLI enables you to manage your workspace at scale – refresh autometrics, edit and run metrics, setup and run deltas, and more. See our CLI documentation for more details, or run bigeye –help from the command line.

This article covers how to get started with the Bigeye-CLI.

Installation

Setting up your local/build environment
Mac with Pyenv

Install brew
Install pyenv
Install python and define a default global:

pyenv install 3.8.10
pyenv global 3.8.10

Conda
Install conda
Create environment with python3.8

conda create -n bigeye_env python=3.8
conda activate bigeye_env

Linux
Most linux distributes include a default python distribution and we recommend using that default.

Installing Bigeye-CLI

You can install the Bigeye-CLI from your command line with the following command:

pip3 install bigeye-cli

Logging into your Bigeye Workspace

Run the following command to get logged into your Bigeye workspace from the CLI:bigeye credential.

There are two ways to authenticate: basic authentication and browser authentication.

Basic Authentication
If you select basic authentication, the CLI will prompt you to enter your Bigeye username and password. This will create a default credential file at ~/.bigeye/default_cred.json. This credential will be used for all CLI commands calls unless an environment variable is explicitly provided.

{
    "base_url": "https://app.bigeye.com",
    "user": "[email protected]",
    "password": "password1234"
}

You can create an environment variable for your workspace credential file, this is helpful if you are managing multiple workspaces and need to flip between them. Add the following to your ~/.bashrc or ~/.zshrc file:

export BIGEYE_API_CRED_FILE=/some/path/to/bigeye_cred_file.json

Lastly, if you want to specify the credential per command, you can always pass a -b parameter with the file path for the desired credential.

Browser Authentication
Alternatively, you can use browser authentication. Login to your bigeye workspace on a Chrome, Chromium or Firefox browser. Run ‘bigeye credential’ and select browser_auth when prompted in the CLI and follow the instructions. If you use Chrome profiles, make sure to specify the profile email address you’re logged into.

Note: your authentication will only be valid so long as your browser session is active.

Overview

Installation

Logging into your Bigeye Workspace

Commands