Maxim CLI

Installation

Shell command to install the CLI

wget https://downloads.getmaxim.ai/cli/<VERSION>/<OS>/<ARCH>/maxim

Example: for linux amd64

wget https://downloads.getmaxim.ai/cli/v1/linux/amd64/maxim

Use .exe extension for windows downloads. For example
wget https://downloads.getmaxim.ai/cli/v1/windows/amd64/maxim.exe

You will require to set these environment variables before using the CLI.

Name	Value
MAXIM_API_KEY	API Key from Settings

Shell command to trigger a test run

maxim test -w <workflow_id> -d <dataset_id> -e <evaluator_names separated by comma>  --json

Argument	Description
-w	Workflow ID or IDs. If you send more than one ID (comma separated), it will create a comparison run.
-d	Dataset ID
-e	Evaluator names. Eg `Bias,BLUE`
--json	Output in JSON (optional)

Introduction

Raising an incident