Installation

The published npm package is @bitslix/blxbench (Bitslix org on npm). After a global install, the command on your PATH is blxbench.

Prerequisites

• Bun (v1.2.0+) — Default for bun install -g. Install via:

  curl -fsSL https://bun.sh/install | bash

• Node.js (v20+) — Used by the global installer’s small launcher when you use npm / pnpm; the app itself runs as a bundled native binary.
• Playwright — Required for some UI/coding tests (optional; see Configuration)

Install blxbench

# Using bun (recommended)
bun install -g @bitslix/blxbench

# Or using pnpm/npm
pnpm add -g @bitslix/blxbench
npm install -g @bitslix/blxbench

# Or clone and build from source (monorepo)
git clone https://github.com/iptoux/blxbench.git
cd blxbench
pnpm install
pnpm --filter @bitslix/blxbench build

Environment Variables

Create a .env file in your project or working directory. Keys depend on which provider adapter you use (see Configuration):

# Example: OpenRouter (default provider alias `opr`)
OPENROUTER_API_KEY=sk-or-...

# Example: direct OpenAI adapter (`oai`)
# OPENAI_API_KEY=sk-...

# Optional: BLXBench API key for headless leaderboard uploads
BLXBENCH_API_KEY=your-api-key

Verify Installation

blxbench --version
# or: blxbench -V

The TUI footer also shows v<version> when you run blxbench interactively.

Next Steps

• Quick Start Guide — Run your first benchmark
• blxbench Reference — Full command documentation