k6

Modern load testing tool using JavaScript. Write performance tests as code and catch regressions before production.

53 commands

Browse by Topic

Getting Started

Quick setup and installation

3commands

Running

Run load tests

12commands

Scripts

Test scripts

8commands

Options

Test options

16commands

Output

Results & export

8commands

Cloud

Cloud execution

6commands

Install k6 (macOS)

$ brew install k6

Install k6 load testing tool using Homebrew on macOS

Install k6 (Linux)

$ sudo apt install k6 -y

Install k6 load testing tool on Debian/Ubuntu Linux

Check k6 version

$ k6 version

Verify k6 installation and display version info

Run test script

$ k6 run script.js

Run a k6 test script.

Run with VUs and duration

$ k6 run --vus 10 --duration 30s script.js

Run with 10 virtual users for 30 seconds.

Run with iterations

$ k6 run --iterations 100 script.js

Run a fixed number of iterations.

Run with environment

$ k6 run -e BASE_URL=https://api.example.com script.js

Run with environment variable.

Run with tags

$ k6 run --tag testid=123 script.js

Run with custom tags.

Run with config file

$ k6 run --config config.json script.js

Run with external config file.

HTTP debug mode

$ k6 run --http-debug=full script.js

Log all HTTP requests and responses.

Skip setup/teardown

$ k6 run --no-setup --no-teardown script.js

Skip setup and teardown functions.

Run paused

$ k6 run --paused script.js

Start test paused, resume via API.

Custom log output

$ k6 run --log-output=file=k6.log script.js

Write k6 logs to a file.

Multiple env variables

$ k6 run -e URL=https://api.example.com -e TOKEN=abc123 script.js

Pass multiple environment variables.

Inspect test script

$ k6 inspect script.js

Show test options without running.

Basic HTTP test

$ import http from 'k6/http'; import { check } from 'k6'; export default function() { const res = http.get('https://api.example.com'); check(res, { 'status is 200': (r) => r.status === 200 }); }

Basic HTTP GET test with check.

POST request

$ const payload = JSON.stringify({ username: 'test' }); const res = http.post(url, payload, { headers: { 'Content-Type': 'application/json' } });

POST JSON data.

Multiple checks

$ check(res, { 'status is 200': (r) => r.status === 200, 'response time < 200ms': (r) => r.timings.duration < 200, 'has body': (r) => r.body.length > 0, });

Multiple response checks.

Group requests

$ import { group } from 'k6'; group('user flow', function() { http.get(url + '/login'); http.get(url + '/dashboard'); });

Group related requests.

Sleep between requests

$ import { sleep } from 'k6'; export default function() { http.get('https://api.example.com'); sleep(1); }

Add think time between requests.

Setup and teardown

$ export function setup() { const res = http.post(url + '/auth', JSON.stringify({ user: 'admin', pass: 'secret' })); return { token: res.json('token') }; } export default function(data) { http.get(url + '/api', { headers: { Authorization: `Bearer ${data.token}` } }); } export function teardown(data) { // cleanup logic }

Use setup/teardown for test lifecycle.

Custom metrics

$ import { Trend, Counter, Rate } from 'k6/metrics'; const myTrend = new Trend('my_api_duration'); const myCounter = new Counter('my_api_calls'); const myRate = new Rate('my_api_success'); export default function() { const res = http.get(url); myTrend.add(res.timings.duration); myCounter.add(1); myRate.add(res.status === 200); }

Define custom metric types.

File upload

$ import { open } from 'k6'; import http from 'k6/http'; const file = open('./data.csv', 'b'); export default function() { http.post(url, { file: http.file(file, 'data.csv') }); }

Upload a file in test.

JSON output

$ k6 run --out json=results.json script.js

Output results to JSON file.

CSV output

$ k6 run --out csv=results.csv script.js

Output results to CSV file.

InfluxDB output

$ k6 run --out influxdb=http://localhost:8086/k6 script.js

Stream results to InfluxDB.

Summary export

$ k6 run --summary-export=summary.json script.js

Export summary to JSON.

Prometheus output

$ k6 run --out experimental-prometheus-rw script.js

Send metrics to Prometheus.

StatsD output

$ k6 run --out statsd script.js

Stream metrics to StatsD.

Multiple outputs

$ k6 run --out json=results.json --out csv=results.csv script.js

Send to multiple output backends.

Datadog output

$ K6_STATSD_ADDR=localhost:8125 k6 run --out output-statsd script.js

Send metrics to Datadog via StatsD.

Login to cloud

$ k6 login cloud --token YOUR_TOKEN

Authenticate with k6 Cloud.

Run in cloud

$ k6 cloud script.js

Run test in k6 Cloud.

Stream to cloud

$ k6 run --out cloud script.js

Run locally, stream to cloud.

Cloud with env token

$ K6_CLOUD_TOKEN=your_token k6 cloud script.js

Authenticate via environment variable.

List cloud tests

$ k6 cloud list

List recent cloud test runs.

Cloud with project ID

$ k6 cloud --project-id 12345 script.js

Run cloud test in specific project.

Discussion

Loading comments...

k6

Modern load testing tool using JavaScript. Write performance tests as code and catch regressions before production.

53 commands

Browse by Topic

Getting Started

Quick setup and installation

3commands

Running

Run load tests

12commands

Scripts

Test scripts

8commands

Options

Test options

16commands

Output

Results & export

8commands

Cloud

Cloud execution

6commands

Install k6 (macOS)

$ brew install k6

Install k6 load testing tool using Homebrew on macOS

Install k6 (Linux)

$ sudo apt install k6 -y

Install k6 load testing tool on Debian/Ubuntu Linux

Check k6 version

$ k6 version

Verify k6 installation and display version info

Run test script

$ k6 run script.js

Run a k6 test script.

Run with VUs and duration

$ k6 run --vus 10 --duration 30s script.js

Run with 10 virtual users for 30 seconds.

Run with iterations

$ k6 run --iterations 100 script.js

Run a fixed number of iterations.

Run with environment

$ k6 run -e BASE_URL=https://api.example.com script.js

Run with environment variable.

Run with tags

$ k6 run --tag testid=123 script.js

Run with custom tags.

Run with config file

$ k6 run --config config.json script.js

Run with external config file.

HTTP debug mode

$ k6 run --http-debug=full script.js

Log all HTTP requests and responses.

Skip setup/teardown

$ k6 run --no-setup --no-teardown script.js

Skip setup and teardown functions.

Run paused

$ k6 run --paused script.js

Start test paused, resume via API.

Custom log output

$ k6 run --log-output=file=k6.log script.js

Write k6 logs to a file.

Multiple env variables

$ k6 run -e URL=https://api.example.com -e TOKEN=abc123 script.js

Pass multiple environment variables.

Inspect test script

$ k6 inspect script.js

Show test options without running.

Basic HTTP test

$ import http from 'k6/http'; import { check } from 'k6'; export default function() { const res = http.get('https://api.example.com'); check(res, { 'status is 200': (r) => r.status === 200 }); }

Basic HTTP GET test with check.

POST request

$ const payload = JSON.stringify({ username: 'test' }); const res = http.post(url, payload, { headers: { 'Content-Type': 'application/json' } });

POST JSON data.

Multiple checks

$ check(res, { 'status is 200': (r) => r.status === 200, 'response time < 200ms': (r) => r.timings.duration < 200, 'has body': (r) => r.body.length > 0, });

Multiple response checks.

Group requests

$ import { group } from 'k6'; group('user flow', function() { http.get(url + '/login'); http.get(url + '/dashboard'); });

Group related requests.

Sleep between requests

$ import { sleep } from 'k6'; export default function() { http.get('https://api.example.com'); sleep(1); }

Add think time between requests.

Setup and teardown

Use setup/teardown for test lifecycle.

Custom metrics

Define custom metric types.

File upload

$ import { open } from 'k6'; import http from 'k6/http'; const file = open('./data.csv', 'b'); export default function() { http.post(url, { file: http.file(file, 'data.csv') }); }

Upload a file in test.

JSON output

$ k6 run --out json=results.json script.js

Output results to JSON file.

CSV output

$ k6 run --out csv=results.csv script.js

Output results to CSV file.

InfluxDB output

$ k6 run --out influxdb=http://localhost:8086/k6 script.js

Stream results to InfluxDB.

Summary export

$ k6 run --summary-export=summary.json script.js

Export summary to JSON.

Prometheus output

$ k6 run --out experimental-prometheus-rw script.js

Send metrics to Prometheus.

StatsD output

$ k6 run --out statsd script.js

Stream metrics to StatsD.

Multiple outputs

$ k6 run --out json=results.json --out csv=results.csv script.js

Send to multiple output backends.

Datadog output

$ K6_STATSD_ADDR=localhost:8125 k6 run --out output-statsd script.js

Send metrics to Datadog via StatsD.

Login to cloud

$ k6 login cloud --token YOUR_TOKEN

Authenticate with k6 Cloud.

Run in cloud

$ k6 cloud script.js

Run test in k6 Cloud.

Stream to cloud

$ k6 run --out cloud script.js

Run locally, stream to cloud.

Cloud with env token

$ K6_CLOUD_TOKEN=your_token k6 cloud script.js

Authenticate via environment variable.

List cloud tests

$ k6 cloud list

List recent cloud test runs.

Cloud with project ID

$ k6 cloud --project-id 12345 script.js

Run cloud test in specific project.

Discussion

Loading comments...