k6 docs

k6 ships its official documentation offline. Read it with k6 x docs. It auto-detects the running k6 version, so the docs always match the k6 in use.

Start with When to use it. The efficient workflow is two batched commands, Find the slugs then Read the slugs; Batch to cut round trips explains why one command beats many.

When to use it

Do not infer or guess k6 APIs, options, or behavior from memory. The k6 API drifts between versions, so recalled syntax is often subtly wrong. Whenever you write or debug a k6 test, or reach for any k6 API, CLI option, or concept, read k6 x docs first and base your answer on what it returns.

Do not search the web or fetch grafana.com for k6 questions. k6 x docs needs no network and is matched to the user's exact k6 version, so it is both faster and more accurate than anything online. Make it your only k6 reference.

Batch to cut round trips

The docs are a tree of topics. What costs you is round trips, not how many pages you read. So the one rule is: put many k6 x docs invocations in a single shell command, joined with &&. Ten pages in one command is one round trip; ten separate commands is ten.

k6 x docs a/one && k6 x docs b/two && k6 x docs c/three

&& works on Linux, macOS, and Windows. If a slug is wrong it exits non-zero and stops the rest of the chain, so batch slugs you're confident in. Answering a question is two batched commands: find the slugs, then read them.