AutoGineer
Generated banner for K6 Docs
Generated logo for K6 Docs

K6 Docs

Grafana LabsOfficialPublished by Grafana Labs

  • Skill
  • Content generator
  • Cloud and DevOps
  • Apache-2.0
  • Low risk
  • Has scripts
Download ZIP

From the author

Write or review k6 documentation across the three k6 repositories - k6-DefinitelyTyped (TypeScript types), k6-docs (user documentation), and k6 (release notes / changelog). Applies k6 doc style conventions, generates TypeScript type definitions, drafts release notes, and validates examples by running them against k6@master. Use when working on k6 documentation, the k6 changelog, the k6 release notes, k6 API reference, k6 TypeScript types, load testing docs, or when the user asks to write, edit, or review anything in the k6, k6-docs, or k6-DefinitelyTyped repos - even if they don't explicitly say "documentation".
— the description by Grafana Labs

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

The k6-docs skill provides a structured approach to managing documentation across the k6 ecosystem. It ensures that user-facing documentation, TypeScript type definitions, and release notes remain accurate and synchronized with the k6 codebase. The skill enforces strict quality standards, including mandatory validation of all code examples against the current k6 master branch and visual verification of rendered documentation using browser-based tools.

What it does

  • Drafts and reviews user documentation for k6 features
  • Generates and maintains TypeScript type definitions
  • Drafts release notes and changelogs for new versions
  • Validates code examples by executing them against k6@master
  • Verifies documentation rendering and link integrity
  • Applies consistent style conventions across all documentation

When to use it

  • When updating or creating k6 API reference documentation
  • When drafting release notes for a new k6 version
  • When modifying TypeScript type definitions for k6
  • When reviewing documentation changes for accuracy and style
  • When verifying that code examples in documentation are functional

Advantages

  • Ensures all documentation code examples are tested and functional
  • Maintains consistency across multiple repositories
  • Prevents broken links and rendering issues through automated checks
  • Automates the validation of TypeScript types
  • Provides a clear, repeatable workflow for documentation maintenance

Usage examples

“Review the new documentation for the k6 browser module.”
The agent will check the documentation against the style guide, verify all links, and run the included code examples against k6@master.
“Generate the release notes for the latest k6 update.”
The agent will draft the release notes, ensuring all mentioned features are documented and examples are validated.
“Update the TypeScript types for the k6 HTTP module.”
The agent will update the type definitions and run tests to ensure they are compatible with the current k6 implementation.

Install

  1. Download the skill as a ZIP:

    https://autogineer.com/agent-skills/grafana/k6-docs/download

  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip k6-docs.zip -d .agents/skills

Documentation by Grafana Labs

k6 Documentation

Document or review k6 features across three repositories: k6-DefinitelyTyped (TypeScript types), k6-docs (user documentation), and k6 (release notes).

Workflow

Pick the workflow that matches the user's intent:

Quick References

Critical Rules

  • Never push automatically - always ask first

  • Never chain commands with && or ; - run each command separately (prevents failures)

  • Only document user-facing features - not internal implementation

  • Use 1. for every numbered list item (not 1., 2., 3.)

  • Test every code example against k6@master before committing

  • No Co-Authored-By: Claude or AI attribution in commits

Validating examples (always run before committing)

Every code example in k6 documentation and release notes must execute cleanly against k6@master. The minimum loop:

# 1. cd into the k6 repo (not k6-docs or k6-DefinitelyTyped)
cd ~/path/to/k6

# 2. Make sure you're on master at the latest commit (the contract is k6@master)
#    First check for local work: if this prints anything, stop and ask the user before switching branches
git status --porcelain
git checkout master
git pull

# 3. Run each example as a separate command (no &&)
go run . run /path/to/script.js

If the run fails: read the error, fix the example in the source (doc or release note), re-run. Do not commit a change whose example doesn't run clean against current master. For the full multi-example workflow with parallel subagents, see references/testing-workflow.md.

Files

references/testing-workflow.md

Testing Workflow for k6 Examples

REQUIRED: All code examples in documentation and release notes must be tested with k6@master using go run . run script.js.

Testing Loop

Follow this loop until 100% of examples pass:

  1. Extract runnable examples (skip blocks with <!-- md-k6:skip --> comment)

  2. Set up dependencies if needed (test servers, mock APIs, etc.)

  3. Launch parallel subagents to test each example (one Task per example in single message)

  4. If failures: launch fix subagent → update docs → re-test ALL examples

  5. Repeat until 100% pass

Testing Subagent Template

Use this template for each example test subagent (Bash subagent type):

Test example <N>: <brief description>

1. Write code to /tmp/k6-test-<name>-<N>.js
2. Run: cd /path/to/k6
3. Run: go run . run /tmp/k6-test-<name>-<N>.js
4. Report: SUCCESS or FAILURE with exit code and full output
5. Clean up temp file

Fix Subagent Template

When examples fail, use this template (general-purpose subagent):

Fix failing examples: [list failures with errors]

1. Analyze failures (API errors, missing imports, timing issues, etc.)
2. Update docs: docs/sources/k6/next/javascript-api/[...]/[method].md
3. Report changes made

allowed-tools: Read, Edit, Grep, Glob

Parallel Launch Pattern

IMPORTANT: Launch all test subagents IN PARALLEL using the Task tool.

Send a SINGLE message with MULTIPLE Task tool calls to run them simultaneously:

Message structure:
- Text explaining what you're testing
- [Invoke Task tool: Test example 1]
- [Invoke Task tool: Test example 2]
- [Invoke Task tool: Test example 3]
- ...

This runs tests concurrently instead of waiting for each to finish sequentially.

After All Examples Fail/Pass

If ALL examples have <!-- md-k6:skip --> markers:

  • Status is ⚠️ UNTESTED (NOT ✅ PASS)

  • Flag this as a concern: "No examples were actually tested"

  • Question whether skip markers are appropriate

  • This is NOT a success - nothing was verified

Do NOT use ✅ or report PASS/SUCCESS/VERIFIED unless you actually ran go run . run and it succeeded.

Prerequisites

k6 repository must be on master branch for testing:

cd /path/to/k6
git status --porcelain  # must print nothing; otherwise stop and ask the user before switching branches
git checkout master
git pull origin master

Requirements and compatibility

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Needs: Needs a command-line tool

Security

What our scanner noticed· Low risk

  • Instructions that use the network
  • Scripts that your agent may run

This skill includes scripts that your agent may run. Read them before you use it.

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Published by
Grafana Labs
Publisher
Grafana Labs (Official)
Source
grafana/skills · skills/grafana-k6/k6-docs · commit 8fb72a5
Licence
Apache License 2.0 (redistribution allowed)
  • LICENSE (added by AutoGineer from LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by Grafana Labs or Grafana Labs.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download k6-docs.zip