Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.harmstack.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

Prebuilt CLI binaries are published on GitHub: vettedmedical/harmstack-install-v0 — latest release Supported builds:
  • macOS — Apple Silicon (darwin/arm64), via Homebrew or manual download
  • Linux — amd64, via Homebrew or manual download
  • Windows — amd64, zip containing harmstack.exe (install from the release asset; Homebrew is not used on Windows)
Platform-specific notes also live in the install repository under platforms/ (for example macOS Apple Silicon, Linux, Windows).

​
Homebrew (macOS Apple Silicon and Linux amd64)

If you use Homebrew, add the tap and install: 
brew tap vettedmedical/harmstack-install-v0 https://github.com/vettedmedical/harmstack-install-v0
brew install harmstack
harmstack --help
To upgrade later: 
brew update && brew upgrade harmstack

​
Manual install (download from GitHub)

Release assets use these names (version varies per release):
  • macOS Apple Silicon: harmstack_<version>_darwin_arm64.tar.gz
  • Linux amd64: harmstack_<version>_linux_amd64.tar.gz
  • Windows amd64: harmstack_<version>_windows_amd64.zip
Each release also includes checksums.txt if you want to verify downloads with SHA-256.
1

Download the archive for your platform

Open the latest release and download the asset for your OS and architecture.
2

Extract and place the binary on your PATH

macOS or Linux — extract the tarball, then move harmstack into a directory on your PATH:
tar -xzf harmstack_*_darwin_arm64.tar.gz
# On Linux amd64, use: harmstack_*_linux_amd64.tar.gz
chmod +x ./harmstack
mkdir -p "$HOME/.local/bin"
mv ./harmstack "$HOME/.local/bin/harmstack"
export PATH="$HOME/.local/bin:$PATH"
harmstack --help
Windows — unzip harmstack_<version>_windows_amd64.zip, move harmstack.exe to a folder on your PATH, open a new terminal, then run 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.