{"id":31702315,"url":"https://github.com/besughi/elixir-k6","last_synced_at":"2025-10-27T08:37:30.660Z","repository":{"id":44537712,"uuid":"406155029","full_name":"besughi/elixir-k6","owner":"besughi","description":"Quick and painless load testing for Elixir applications.","archived":false,"fork":false,"pushed_at":"2023-09-14T19:58:39.000Z","size":116,"stargazers_count":40,"open_issues_count":1,"forks_count":4,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-09-06T04:07:17.609Z","etag":null,"topics":["elixir","k6","load-testing"],"latest_commit_sha":null,"homepage":"","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/besughi.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-09-13T23:06:47.000Z","updated_at":"2025-06-16T16:53:17.000Z","dependencies_parsed_at":"2023-02-11T15:31:20.993Z","dependency_job_id":null,"html_url":"https://github.com/besughi/elixir-k6","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/besughi/elixir-k6","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/besughi%2Felixir-k6","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/besughi%2Felixir-k6/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/besughi%2Felixir-k6/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/besughi%2Felixir-k6/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/besughi","download_url":"https://codeload.github.com/besughi/elixir-k6/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/besughi%2Felixir-k6/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279000701,"owners_count":26082837,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-08T02:00:06.501Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["elixir","k6","load-testing"],"created_at":"2025-10-08T21:50:46.729Z","updated_at":"2025-10-08T21:50:50.464Z","avatar_url":"https://github.com/besughi.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003ch1 style=\"width: 100%; text-align: center\"\u003eElixir-K6\u003c/h1\u003e\n  \u003cp style=\"font-size: 18px; white-space: pre-line\"\u003eQuick and painless load testing for Elixir applications.\n    Generate and run load tests via a local installation of \u003ca href=\"https://k6.io\"\u003ek6\u003c/a\u003e.\n  \u003c/p\u003e\n  \u003cp\u003e\n    Originally developed at \u003ca href=\"https://spawnfest.org/\"\u003eSpawnFest\u003c/a\u003e 2021.\n  \u003c/p\u003e\n\u003c/div\u003e\n\u003cdiv align=\"center\" style=\"text-align: center;\"\u003e\n  \u003cimg alt=\"Hex.pm\" src=\"https://img.shields.io/hexpm/l/k6\"\u003e\n  \u003cimg alt=\"GitHub Workflow Status\" src=\"https://img.shields.io/github/actions/workflow/status/besughi/elixir-k6/ci.yml?branch=main\"\u003e\n  \u003cimg alt=\"Hex.pm\" src=\"https://img.shields.io/hexpm/v/k6\"\u003e\n\u003c/div\u003e\n\n## Installation\n\nThe package can be installed by adding `k6` to your list of dependencies in `mix.exs`:\n\n```elixir\ndef deps do\n  [\n    {:k6, \"~\u003e 0.2.1\"}\n  ]\nend\n```\n\n## Usage\n\nTo generate new k6 tests run:\n\n```shell\nmix k6.gen.test \u003ctest_name\u003e\n```\n\nBy default k6 tests will be placed under the `priv/k6` directory of your project.\n\nThe template to use for the test can be set via the `--type` argument.\nSupported types are `rest` (default), `graphql`, `grpc`, `websocket`, `phoenix-channel` (experimental) and `liveview` (experimental).\n\nRun `mix help k6.gen.test` for more info on generating tests.\n\nTo execute k6 tests run:\n\n```shell\nmix k6 run \u003ctest_name\u003e.js\n```\n\nRun `mix help k6` for more info on running k6.\n\n### Configuration\n\n`elixir-k6` can be configured via `config.exs` as follows:\n\n```elixir\nconfig :k6,\n  version: \"vX.Y.Z\",\n  env: [VAR_KEY: \"some value\"],\n  workdir: \"priv/my_load_tests_dir\"\n```\n\nThe supported configuration parameters are:\n\n- `version`: the desired version of k6. Defaults to `v0.39.0`.\n- `env`: environment variables to pass to load tests. K6 will expose those variables to load test scripts within the `__ENV` object.\n- `workdir`: path of the directory that contains k6 load tests. Relative to the project, defaults to `priv/k6`.\n\n### K6 installation\n\nK6 is automatically installed the first time you run k6 tests, and it is stored in `_build/k6`.\nIn case you want to explicitly install it before running any test, you can run `mix k6.install`.\n\nAt the moment the following architectures are supported:\n\n|  OS   |    Architecture    |\n| :---: | :----------------: |\n| MacOs |       amd64        |\n| MacOs | arm64 (not tested) |\n| Linux |       amd64        |\n| Linux | arm64 (not tested) |\n\nBy default the installation task will install k6 version `v0.39.0`.\nYou can override this in your config file, as documented above.\n\n## Contributing\n\nIssues and contributions are welcome!\n\nTo run static analysis run:\n\n```shell\nmix check\n```\n\nTo execute tests run:\n\n```shell\nmix test\n```\n\nThe test suite also includes some end-to-end tests, which are not executed by default as they are much slower.\nTo execute all tests run:\n\n```shell\nmix test --include end_to_end\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbesughi%2Felixir-k6","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbesughi%2Felixir-k6","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbesughi%2Felixir-k6/lists"}