k6-lookup-docs

Look up local k6 documentation with fuzzy search and path validation.

6|1|Updated Feb 26, 2026
One-click install
npx skills add https://github.com/grafana/xk6-subcommand-docs --skill k6-lookup-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: k6-lookup-docs
Source: https://github.com/grafana/xk6-subcommand-docs/tree/main/skills/k6-lookup-docs
Command: npx skills add https://github.com/grafana/xk6-subcommand-docs --skill k6-lookup-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

Provides fast, local, and version-aligned access to k6 documentation so developers and AI agents never have to leave the terminal or rely on networked documentation during test authoring and troubleshooting.

Core Features & Use Cases

  • Local & Versioned Docs: Uses a cached k6 docs bundle so content matches your k6 build and works offline.
  • Precise Lookups: Navigate module APIs, protocol guides, examples, and configuration topics using full parent paths and nested topic drilling.
  • Search & Validation: Fuzzy search for keywords, depth-limited TOC views, and a validation script to test lookup paths against a k6 binary.
  • Agent Integration: Designed for interactive terminal use and integration with AI coding agents for automated reference lookups while authoring tests.

Quick Start

Run ./k6 x docs javascript-api k6-http get to view the HTTP get function documentation from your local k6 binary.

Frequently Asked Questions about k6-lookup-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I look up k6 documentation locally from the terminal?

Use the k6 binary with the docs command and provide the full parent path to the desired module API or topic. This enables offline reference and avoids network-dependent searches during test authoring.

Can I search k6 module APIs and configuration guides offline?

Yes, k6 documentation lookup supports fuzzy search and depth-limited TOC views over a cached local docs bundle. This provides offline access to module APIs, protocol guides, and configuration topics matched to your k6 build.

Does k6 offline documentation lookup work with AI coding agents?

Yes, the k6 documentation lookup is designed for AI coding agent integration, enabling automated reference lookups while authoring tests. Agents query module APIs and configuration topics using full parent path lookups directly from the terminal.

What's the best way to validate k6 documentation lookup paths against a k6 binary?

Use the included validation script to test lookup paths against a provided k6 binary. This verifies that full parent path lookups and nested topic drilling accurately resolve module APIs and configuration topics.

How do I navigate nested k6 protocol guides and examples using full parent paths?

Provide the full parent path to the docs command to drill down into nested k6 protocol guides and examples. This supports precise lookups of module APIs and configuration topics directly from the terminal.