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.