Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

man page for k6 #2347

Closed
na-- opened this issue Jan 19, 2022 · 2 comments
Closed

man page for k6 #2347

na-- opened this issue Jan 19, 2022 · 2 comments

Comments

@na--
Copy link
Member

na-- commented Jan 19, 2022

Feature Description

The current .deb and .rpm packages don't have a man page. This is a problem for *nix users that are used to these, especially for CLI tooks like k6.

Suggested Solution (optional)

We should probably add at least a basic manpage with the main options and a link to https://k6.io/docs/. In the future, we can expand that to sub-pages (e.g. man k6-run) and auto-generate them, but we should at least start somewhere.

Already existing or connected issues / PRs (optional)

Somewhat loosely related issues: #2154, #1970

@chenrui333
Copy link

however the tldr actually works

$ tldr k6

  Open source load testing tool and SaaS for engineering teams.
  More information: <https://k6.io>.

  Run load test locally:

      k6 run script.js

  Run load test locally with a given number of virtual users and duration:

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

  Run load test locally with a given environment variable:

      k6 run -e HOSTNAME=example.com script.js

  Run load test locally using InfluxDB to store results:

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

  Run load test locally and discard response bodies (significantly faster):

      k6 run --discard-response-bodies script.js

  Run load test locally using the base JavaScript compatibility mode (significantly faster):

      k6 run --compatibility-mode=base script.js

  Log in to cloud service using secret token:

      k6 login cloud --token secret

  Run load test on cloud infrastructure:

      k6 cloud script.js

yashagarwal0812 added a commit to yashagarwal0812/k6 that referenced this issue Mar 11, 2025

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@mstoykov
Copy link
Contributor

As said in the PR opened for this, the team has decided that we do not want to maintain a man page and documentation separately. At this time there seems to be no to small interest in a man page, so I will be closing this.

@mstoykov mstoykov closed this as not planned Won't fix, can't repro, duplicate, stale Mar 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants