{"id":27171431,"url":"https://github.com/codspeedhq/runner","last_synced_at":"2026-01-21T15:01:15.023Z","repository":{"id":209036738,"uuid":"717528657","full_name":"CodSpeedHQ/runner","owner":"CodSpeedHQ","description":"CodSpeed runner, gathering performance data from CI environments","archived":false,"fork":false,"pushed_at":"2026-01-15T12:53:46.000Z","size":4406,"stargazers_count":26,"open_issues_count":16,"forks_count":6,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-15T15:51:21.187Z","etag":null,"topics":["benchmark","github-actions"],"latest_commit_sha":null,"homepage":"https://codspeed.io","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CodSpeedHQ.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2023-11-11T18:35:22.000Z","updated_at":"2026-01-14T17:55:27.000Z","dependencies_parsed_at":"2023-12-25T20:58:10.975Z","dependency_job_id":"12ec07fa-ee84-4c14-8c1b-cf2a7aa3a7dc","html_url":"https://github.com/CodSpeedHQ/runner","commit_stats":null,"previous_names":["codspeedhq/runner"],"tags_count":104,"template":false,"template_full_name":null,"purl":"pkg:github/CodSpeedHQ/runner","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodSpeedHQ%2Frunner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodSpeedHQ%2Frunner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodSpeedHQ%2Frunner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodSpeedHQ%2Frunner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CodSpeedHQ","download_url":"https://codeload.github.com/CodSpeedHQ/runner/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodSpeedHQ%2Frunner/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28635123,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-21T14:50:40.221Z","status":"ssl_error","status_checked_at":"2026-01-21T14:48:59.225Z","response_time":86,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["benchmark","github-actions"],"created_at":"2025-04-09T08:34:27.504Z","updated_at":"2026-01-21T15:01:14.989Z","avatar_url":"https://github.com/CodSpeedHQ.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\u003ch1\u003eCodSpeed CLI\u003c/h1\u003e\n\nCLI to gather performance data and upload performance reports to [CodSpeed](https://codspeed.io)\n\n[![CI](https://github.com/CodSpeedHQ/runner/actions/workflows/ci.yml/badge.svg)](https://github.com/CodSpeedHQ/runner/actions/workflows/ci.yml)\n[![Discord](https://img.shields.io/badge/chat%20on-discord-7289da.svg)](https://discord.com/invite/MxpaCfKSqF)\n[![CodSpeed Badge](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/)\n\n\u003c/div\u003e\n\nThe `codspeed` CLI is designed to be used both in **local** in **CI environments**.\n\nThe following CI providers are supported:\n\n- [GitHub Actions](https://docs.codspeed.io/integrations/ci/github-actions): Usage with [`@CodSpeedHQ/action`](https://github.com/CodSpeedHQ/action) is recommended.\n- [GitLab CI](https://docs.codspeed.io/integrations/ci/gitlab-ci)\n- [Buildkite](https://docs.codspeed.io/integrations/ci/buildkite)\n\n#### Other providers\n\nIf you want to use the CLI with another provider, you can open an issue or chat with us on [Discord](https://discord.com/invite/MxpaCfKSqF) 🚀\n\nYou can check out the implementation of the [supported providers](https://github.com/CodSpeedHQ/runner/tree/main/src/run/run_environment) for reference.\n\n## Installation\n\n```bash\ncurl -fsSL https://github.com/CodSpeedHQ/runner/releases/latest/download/codspeed-runner-installer.sh | bash\nsource \"$HOME/.cargo/env\"\n```\n\nRefer to the [releases page](https://github.com/CodSpeedHQ/runner/releases) to see all available versions.\n\n## Usage\n\n\u003e [!NOTE]\n\u003e For now, the CLI only supports Ubuntu 20.04, 22.04, 24.04 and Debian 11, 12.\n\nFirst, authenticate with your CodSpeed account:\n\n```bash\ncodspeed auth login\n```\n\nThen, run benchmarks with the following command:\n\n```bash\ncodspeed run \u003cmy-benchmark-command\u003e\n\n# Example, using https://github.com/CodSpeedHQ/codspeed-rust\ncodspeed run cargo codspeed run\n\n# Example, using https://github.com/CodSpeedHQ/pytest-codspeed\ncodspeed run pytest ./tests --codspeed\n\n# Example, using https://github.com/CodSpeedHQ/codspeed-node/tree/main/packages/vitest-plugin\ncodspeed run pnpm vitest bench\n```\n\n## Advanced usage\n\n### Installing tools before running\n\nYou can install executors and instruments before running the benchmark with the `setup` command:\n\n```bash\ncodspeed setup\n```\n\nThis is especially useful when configuring environments with tools such as docker.\n\n### Logging level\n\nUse the `CODSPEED_LOG` environment variable to set the logging level:\n\n```bash\nCODSPEED_LOG=debug codspeed run ...\n```\n\n### Changing the mode of the runner\n\nBy default, the runner will run the benchmark in the `instrumentation` mode. You can specify the mode with the `--mode` flag of the `run` command:\n\n```bash\n# Run in the `instrumentation` mode\ncodspeed run --mode instrumentation \u003cmy-benchmark-command\u003e\n\n# Run in the `walltime` mode\ncodspeed run --mode walltime \u003cmy-benchmark-command\u003e\n```\n\n\u003e [!WARNING]\n\u003e We strongly recommend not changing this mode unless you know what you are doing.\n\u003e Using the `walltime` mode on traditional VMs/Hosted Runners will lead to inconsistent data. For the best results, we recommend using CodSpeed Hosted Macro Runners, which are fine-tuned for performance measurement consistency.\n\u003e Check out the [Walltime Instrument Documentation](https://docs.codspeed.io/instruments/walltime/) for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodspeedhq%2Frunner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodspeedhq%2Frunner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodspeedhq%2Frunner/lists"}