Installation

blop is a single npm package that ships a blop CLI, a runtime, browser tools, and reporters.

Prerequisites

• Bun runtime (or Node.js 20+).
• An AI provider API key — Blop supports OpenAI, Anthropic, Google, Groq, xAI, OpenRouter, Mistral, Cerebras, and NVIDIA via Khadim.
• A target app running locally or at a reachable URL.
• Playwright browsers — install with bunx playwright install chromium before your first run.

Note

See Agent providers for per-provider setup notes and model recommendations.

Install the package

$ bun add blop
# or
$ pnpm add blop
# or
$ npm install blop

Install Playwright browsers

blop drives a real browser via Playwright. On a fresh machine, install the browser binaries once:

$ bunx playwright install chromium

For all engines (Chromium, Firefox, WebKit):

$ bunx playwright install

In CI, add --with-deps to install system dependencies on Linux runners:

$ bunx playwright install --with-deps chromium

Set provider credentials

blop reads provider configuration from three sources, in order of precedence: CLI flags, environment variables, and blop.config.ts.

The simplest path is environment variables:

$ export BLOP_AGENT_PROVIDER=openai
$ export BLOP_AGENT_MODEL=gpt-5
$ export BLOP_AGENT_API_KEY=sk-...

Provider-native env vars also work as fallbacks when BLOP_AGENT_API_KEY is unset:

Provider	Native env var
OpenAI	OPENAI_API_KEY
Anthropic	ANTHROPIC_API_KEY
Google	GEMINI_API_KEY
Groq	GROQ_API_KEY
xAI	XAI_API_KEY
OpenRouter	OPENROUTER_API_KEY
Mistral	MISTRAL_API_KEY
Cerebras	CEREBRAS_API_KEY
NVIDIA	NVIDIA_API_KEY

See Agent providers for the full list and model recommendations.

Verify the install

$ bunx blop --help

You should see the help text listing every command and flag. Next, head to first steps to write and run your first test.