Quickstart

From install to first result.

About 5 minutes, start to finish. Every command below is real — nothing here is aspirational.

All you need is a terminal — Terminal.app on macOS, PowerShell on Windows. No Python, no package manager required first.

1. Install

The fastest, best-supported way to install and stay up to date — no Python needed, self-upgrades on re-run:

curl -fsSL https://raw.githubusercontent.com/Nexus-InferGauge/infergauge-releases/main/install.sh | sh

Or download the tarball manually

Not on Linux? Windows · macOS

The first run may show an OS security prompt — expected for an unsigned build, not a sign anything's wrong. Windows: SmartScreen — click More info → Run anyway. macOS: installing via curl usually skips Gatekeeper's warning entirely; if you ever see one, right-click the file → Open. Linux: no warning — chmod +x the binary if it isn't already executable.

Don't double-click the downloaded binary — it's a command-line program with no window of its own. Double-clicking opens a console, runs with no arguments, prints a usage error, and closes again, which looks like a crash but isn't. Always run it from a terminal you opened yourself.

Other ways to install

pip:

pip install infergauge
infergauge init -y && infergauge run

Homebrew (macOS/Linux):

brew install Nexus-InferGauge/infergauge/infergauge

2. Create your account

Free — no card, no license key. 25 concurrent users, 120 seconds per run, 10 runs a month.

Create account

3. Sign in and run your first test

infergauge login --server https://console.infergauge.com

infergauge init                 # interactive setup -> infergauge.yaml
infergauge run --sync           # live dashboard opens, results sync to the console

Pick the Simulator provider during init and you don't need an API key at all — it behaves like a real endpoint, degrading past a saturation point and rate-limiting under load, so every chart and insight in the dashboard lights up on the very first run.

You only sign in once per machine — after that, always pass --sync and results show up in the console's Overview and Runs tabs automatically.

Testing a real model API? Never put the key in infergauge.yaml — export it as an environment variable instead. Configs get committed, attached to bug reports, and shared with teammates; a key inside one will eventually leak. Full walkthrough (including the exact export commands per OS) is in the quick start guide.

4. Need more than Free?

Spike or endurance tests, self-hosted endpoints, or unlimited runs need a license token from us — once you have one:

Paste it into the console

Using the CLI

infergauge login --server https://console.infergauge.com
infergauge run infergauge.yaml --sync

Signing in once and always passing --sync is enough — the CLI checks the account's real entitlement on the console at run time, so a console upgrade just works. Fully offline/air-gapped use is the one exception, using INFERGAUGE_API_KEY/INFERGAUGE_FERNET_KEY environment variables instead — see the quick start guide for that path.

Something not matching what you see?

The full guide covers every platform in detail, updating an existing install, and troubleshooting — from Gatekeeper warnings to a stray old pip install silently taking priority.

Full guide Contact us