Installation
Shell command to install the CLI
Example: for linux amd64
Use .exe extension for windows downloads. For example
wget https://downloads.getmaxim.ai/cli/v1/windows/amd64/maxim.exeSupported OS + ARCH
| OS | ARCH |
| Linux | amd64 |
| Linux | 386 |
| Darwin | amd64 |
| Darwin | arm64 |
| Windows | amd64 |
| Windows | 386 |
Env Variables
You will require to set these environment variables before using the CLI.| Name | Value |
| MAXIM_API_KEY | API Key from Settings |
Trigger a test run
Shell command to trigger a test run
| 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,BLEU |
| —json | Output in JSON (optional) |
Programmatic Evaluator Management
Shell command to push an evaluator
| Argument | Description |
| —file | Path to evaluator code file (.py, .js, .mjs, .cjs) |
| —workspace | Workspace ID |
| —name | Evaluator name |
| —response-type | Response type (Boolean, Number, String). Default: Number |
| —pass-criteria | Pass/fail criteria as JSON (e.g. ’{“entryLevel”:{“name”:“score”,“operator”:”>=”,“value”:0.9},“runLevel”:{“name”:“queriesPassed”,“operator”:”>=”,“value”:90}}’) |
| —optional-variables | Comma-separated list of variable names to mark as optional (e.g. ‘context,metadata’) |