Skip to main content
The harmstack CLI lets you run benchmarks against AI model endpoints, inspect job results, compare runs, and manage account credits from your terminal. It supports both an interactive wizard and a non-interactive flag-based workflow.

​
Installation

1

Download the latest binary

Install the latest release for your platform from: vettedmedical/harmstack-install-v0 (latest release)Binaries are available for macOS (Apple Silicon), Windows, and Linux.
2

Add the binary to your PATH

Move the downloaded binary to a directory on your PATH and ensure it is executable.Example (macOS/Linux):
chmod +x ./harmstack
mkdir -p "$HOME/.local/bin"
mv ./harmstack "$HOME/.local/bin/harmstack"
export PATH="$HOME/.local/bin:$PATH"
harmstack --help
3

Verify the installation

Confirm the CLI is available:
harmstack --help
You should see top-level help output listing all available customer commands.

​
Authentication

Set your Harmstack API key before running commands: 
export HARMSTACK_API_KEY=your_api_key_here
You can then run commands like: 
harmstack credits
Store HARMSTACK_API_KEY in your shell profile (for example ~/.bashrc or ~/.zshrc) so you do not need to export it every session.Example (zsh):
echo 'export HARMSTACK_API_KEY="your_api_key_here"' >> ~/.zshrc
source ~/.zshrc

​
Explore the CLI

Commands

Full reference for every customer-facing harmstack command, with usage examples and key flags.

Flags

Canonical kebab-case flags only (for example --job-id, --benchmark-id, --unit-count), with types, defaults, and environment variable fallbacks.