{"id":34246457,"url":"https://github.com/use-tusk/tusk-drift-cli","last_synced_at":"2026-03-14T07:15:17.901Z","repository":{"id":317309957,"uuid":"1066745758","full_name":"Use-Tusk/tusk-drift-cli","owner":"Use-Tusk","description":"Record traces from your live traffic and replay them as API tests","archived":false,"fork":false,"pushed_at":"2026-01-25T07:23:11.000Z","size":10341,"stargazers_count":125,"open_issues_count":6,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-01-25T12:38:10.582Z","etag":null,"topics":["api-testing","mock","test-automation","test-automation-framework","test-generation","testing","testing-library","traffic-replay"],"latest_commit_sha":null,"homepage":"https://www.usetusk.ai/tusk-drift","language":"Go","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/Use-Tusk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-29T22:45:55.000Z","updated_at":"2026-01-24T23:47:58.000Z","dependencies_parsed_at":"2025-09-30T06:19:26.910Z","dependency_job_id":"72d2586a-2e02-4c87-9bc5-b8007f58fe32","html_url":"https://github.com/Use-Tusk/tusk-drift-cli","commit_stats":null,"previous_names":["use-tusk/tusk-drift-cli"],"tags_count":43,"template":false,"template_full_name":null,"purl":"pkg:github/Use-Tusk/tusk-drift-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Use-Tusk%2Ftusk-drift-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Use-Tusk%2Ftusk-drift-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Use-Tusk%2Ftusk-drift-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Use-Tusk%2Ftusk-drift-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Use-Tusk","download_url":"https://codeload.github.com/Use-Tusk/tusk-drift-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Use-Tusk%2Ftusk-drift-cli/sbom","scorecard":{"id":1241374,"data":{"date":"2026-01-10T02:13:45Z","repo":{"name":"github.com/Use-Tusk/tusk-drift-cli","commit":"861cc082fa2ec56c1595c6e256483969d2004f18"},"scorecard":{"version":"v5.3.0","commit":"c22063e786c11f9dd714d777a687ff7c4599b600"},"score":8.2,"checks":[{"name":"Maintained","score":10,"reason":"30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#binary-artifacts"}},{"name":"Security-Policy","score":10,"reason":"security policy file detected","details":["Info: security policy file detected: SECURITY.md:1","Info: Found linked content: SECURITY.md:1","Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1","Info: Found text in security policy: SECURITY.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#security-policy"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":10,"reason":"all changesets reviewed","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":10,"reason":"GitHub workflow tokens follow principle of least privilege","details":["Info: jobLevel 'actions' permission set to 'read': .github/workflows/release.yml:51","Info: topLevel 'contents' permission set to 'read': .github/workflows/e2e-node.yml:10","Info: topLevel 'contents' permission set to 'read': .github/workflows/main.yml:10","Info: topLevel 'contents' permission set to 'read': .github/workflows/release.yml:11","Info: topLevel permissions set to 'read-all': .github/workflows/scorecard.yml:8","Info: topLevel 'contents' permission set to 'read': .github/workflows/tusk-tester.yml:25","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":9,"reason":"dependency not pinned by hash detected -- score normalized to 9","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:55: update your workflow using https://app.stepsecurity.io/secureworkflow/Use-Tusk/tusk-drift-cli/release.yml/main?enable=pin","Info:  16 out of  16 GitHub-owned GitHubAction dependencies pinned","Info:   4 out of   5 third-party GitHubAction dependencies pinned","Info:   1 out of   1 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#pinned-dependencies"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#license"}},{"name":"Dependency-Update-Tool","score":0,"reason":"no update tool detected","details":["Warn: no dependency update tool configurations found"],"documentation":{"short":"Determines if the project uses a dependency update tool.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#dependency-update-tool"}},{"name":"CII-Best-Practices","score":5,"reason":"badge detected: Passing","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#cii-best-practices"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#vulnerabilities"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/release.yml:14"],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#packaging"}},{"name":"Signed-Releases","score":10,"reason":"5 out of the last 5 releases have a total of 5 signed artifacts.","details":["Info: provenance for release artifact: multiple.intoto.jsonl: https://github.com/Use-Tusk/tusk-drift-cli/releases/tag/v0.1.37","Info: provenance for release artifact: multiple.intoto.jsonl: https://github.com/Use-Tusk/tusk-drift-cli/releases/tag/v0.1.36","Info: provenance for release artifact: multiple.intoto.jsonl: https://github.com/Use-Tusk/tusk-drift-cli/releases/tag/v0.1.35","Info: provenance for release artifact: multiple.intoto.jsonl: https://github.com/Use-Tusk/tusk-drift-cli/releases/tag/v0.1.34","Info: provenance for release artifact: multiple.intoto.jsonl: https://github.com/Use-Tusk/tusk-drift-cli/releases/tag/v0.1.33"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":5,"reason":"branch protection is not maximal on development and all release branches","details":["Info: 'allow deletion' disabled on branch 'main'","Info: 'force pushes' disabled on branch 'main'","Warn: 'branch protection settings apply to administrators' is disabled on branch 'main'","Warn: 'stale review dismissal' is disabled on branch 'main'","Warn: required approving review count is 1 on branch 'main'","Warn: codeowners review is not required on branch 'main'","Warn: 'last push approval' is disabled on branch 'main'","Warn: no status checks found to merge onto branch 'main'","Info: PRs are required in order to make changes on branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#branch-protection"}},{"name":"SAST","score":10,"reason":"SAST tool is run on all commits","details":["Info: all commits (30) are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#sast"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#fuzzing"}},{"name":"Contributors","score":6,"reason":"project has 2 contributing companies or organizations -- score normalized to 6","details":["Info: found contributions from: tusk, use-tusk"],"documentation":{"short":"Determines if the project has a set of contributors from multiple organizations (e.g., companies).","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#contributors"}},{"name":"CI-Tests","score":10,"reason":"30 out of 30 merged PRs checked by a CI test -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project runs tests before pull requests are merged.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#ci-tests"}}]},"last_synced_at":"2026-01-13T10:46:49.725Z","repository_id":317309957,"created_at":"2026-01-13T10:46:49.734Z","updated_at":"2026-01-13T10:46:49.734Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28844011,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-28T07:39:25.367Z","status":"ssl_error","status_checked_at":"2026-01-28T07:39:24.487Z","response_time":57,"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":["api-testing","mock","test-automation","test-automation-framework","test-generation","testing","testing-library","traffic-replay"],"created_at":"2025-12-16T07:02:17.403Z","updated_at":"2026-03-14T07:15:17.895Z","avatar_url":"https://github.com/Use-Tusk.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Tusk CLI Banner](assets/tusk-banner.png)\n\nTusk Drift is an API test record/replay system that lets you run realistic tests generated from real traffic. This CLI orchestrates local and CI test runs, coordinating with a Tusk Drift SDK and Tusk Drift Cloud.\n\n\u003cdiv align=\"center\"\u003e\n\n![GitHub Release](https://img.shields.io/github/v/release/Use-Tusk/tusk-drift-cli)\n[![Build and test](https://github.com/Use-Tusk/tusk-drift-cli/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/Use-Tusk/tusk-drift-cli/actions/workflows/main.yml)\n[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/11340/badge)](https://www.bestpractices.dev/projects/11340)\n[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/Use-Tusk/tusk-drift-cli/badge)](https://securityscorecards.dev/viewer/?uri=github.com/Use-Tusk/tusk-drift-cli)\n\u003cbr\u003e\n[![Go Report Card](https://goreportcard.com/badge/github.com/Use-Tusk/tusk-drift-cli)](https://goreportcard.com/report/github.com/Use-Tusk/tusk-drift-cli)\n[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n[![X URL](https://img.shields.io/twitter/url?url=https%3A%2F%2Fx.com%2Fusetusk\u0026style=flat\u0026logo=x\u0026label=Tusk\u0026color=BF40BF)](https://x.com/usetusk)\n[![Slack URL](https://img.shields.io/badge/slack-badge?style=flat\u0026logo=slack\u0026label=Tusk\u0026color=BF40BF)](https://join.slack.com/t/tusk-community/shared_invite/zt-3fve1s7ie-NAAUn~UpHsf1m_2tdoGjsQ)\n\n\u003c/div\u003e\n\nSDKs:\n\n- [Node.js](https://github.com/Use-Tusk/drift-node-sdk)\n- [Python](https://github.com/Use-Tusk/drift-python-sdk)\n- ...more to come!\n\n## Features\n\n- Replay recorded traces against your service under test\n- Deterministic outbound I/O via local mock server\n- JSON response comparison with dynamic field rules (UUIDs, timestamps, dates, etc.)\n- Tusk Drift Cloud: fetch and replay tests stored with Tusk, and upload test results for intelligent classification of regressions in CI/CD checks\n\n\u003cdiv align=\"center\"\u003e\n\n![Demo](assets/demo.gif)\n\u003cp\u003e\u003ca href=\"https://github.com/Use-Tusk/drift-node-demo\"\u003eTry it on a demo repo →\u003c/a\u003e\u003c/p\u003e\n\n\u003c/div\u003e\n\n## Install\n\n### Quick install (recommended)\n\n**Linux/macOS:**\n\nInstall the latest version:\n\n```bash\ncurl -fsSL https://cli.usetusk.ai/install.sh | sh\n```\n\nTo install a specific version:\n\n```bash\ncurl -fsSL https://cli.usetusk.ai/install.sh | sh -s -- v1.2.3\n```\n\nLinux additional dependencies (for replay sandboxing):\n\n- Debian/Ubuntu: `sudo apt install bubblewrap socat`\n- Fedora/RHEL: `sudo dnf install bubblewrap socat`\n- Arch: `sudo pacman -S bubblewrap socat`\n\nWithout these, sandboxing is disabled and replays run without network isolation. See [Architecture - Sandboxing](docs/architecture.md#sandboxing-with-fence).\n\n**Homebrew:**\n\n```bash\nbrew tap use-tusk/tap\nbrew install use-tusk/tap/tusk\n```\n\nTo update:\n\n```bash\nbrew upgrade use-tusk/tap/tusk\n```\n\n**Windows:**\n\nWe recommend using [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) for the best experience on Windows. With WSL, you can use the Linux/macOS installation steps above and avoid Windows-specific configuration. For native Windows installation without WSL, expand below to see the steps.\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cb\u003eInstallation steps\u003c/b\u003e\u003c/summary\u003e\nDownload the latest release from [GitHub Releases](https://github.com/Use-Tusk/tusk-drift-cli/releases/latest):\n\n1. Download `tusk-drift-cli_*_Windows_x86_64.zip` (or `arm64` for ARM-based Windows)\n2. Extract the ZIP file\n3. Move `tusk.exe` to a directory in your PATH (e.g., `C:\\tools\\`), or add the extracted directory to your PATH:\n\n   **Option A: Add to PATH via PowerShell (run as Administrator):**\n\n   ```powershell\n   [Environment]::SetEnvironmentVariable(\"Path\", $env:Path + \";C:\\path\\to\\tusk\", \"User\")\n   ```\n\n   **Option B: Add to PATH via System Settings:**\n   - Press `Win + R`, type `sysdm.cpl`, press Enter\n   - Click \"Environment Variables\"\n   - Under \"User variables\", select `Path` and click \"Edit\"\n   - Click \"New\" and add the folder containing `tusk.exe`\n   - Click OK to save\n\n4. Restart your terminal and verify:\n\n   ```powershell\n   tusk --version\n   ```\n\nNote: Windows requires additional configuration for running tests. See [Windows Support](docs/configuration.md#windows-support) for details on TCP communication mode setup.\n\u003c/details\u003e\n\n### Manual Download\n\nDownload pre-built binaries from [GitHub Releases](https://github.com/Use-Tusk/tusk-drift-cli/releases/latest).\n\n### Build from source\n\n```bash\n# Go 1.25+\ngit clone https://github.com/Use-Tusk/tusk-drift-cli.git\ncd tusk-drift-cli\nmake deps\nmake build\n\ntusk --help\n```\n\n## Quick start\n\n### AI-powered setup (recommended)\n\nUse our AI agent to automatically set up Tusk Drift for your service:\n\n```bash\ncd path/to/your/service\ntusk drift setup\n```\n\nThe agent will analyze your codebase, instrument the SDK, create configuration files, and test the setup with recording and replay. Supported languages: Python and Node.js.\n\n### Manual setup\n\nAlternatively, use the interactive wizard:\n\n```bash\ncd path/to/your/service\ntusk drift init\n```\n\nThis will guide you to create your `.tusk/config.yaml` config file. You can also create the `.tusk` directory and config file manually. See [configuration docs](/docs/configuration.md).\n\nYou will need to record traces for your service. See your respective SDK's guide for more details. Once you have traces recorded, you can replay them with the `tusk drift run` command.\n\nLocal traces (default):\n\n```bash\n# Run all tests from local traces\ntusk drift run\n\n# Or specify source\ntusk drift run --trace-dir .tusk/traces\ntusk drift run --trace-file path/to/trace.jsonl\ntusk drift run --trace-id \u003ctraceId\u003e\n\n# Common flags\ntusk drift run --filter '^/api/users' --concurrency 10 --enable-service-logs\ntusk drift run --save-results --results-dir .tusk/results\ntusk drift run --sandbox-mode auto   # default: auto (choices: auto|strict|off)\n```\n\n## ✨ Tusk Drift Cloud\n\n\u003cdiv align=\"center\"\u003e\n\n![Tusk Drift Animated Diagram](assets/tusk-drift-animated-diagram-light.gif#gh-light-mode-only)\n![Tusk Drift Animated Diagram](assets/tusk-drift-animated-diagram-dark.gif#gh-dark-mode-only)\n\n\u003c/div\u003e\n\nYou can use Tusk Drift as API tests in your CI/CD pipeline by running your test suite against commits in your pull requests. Tusk Drift Cloud offers storage of these tests alongside an additional layer of intelligence on deviations detected:\n\n- Automatic recording of traces based on live traffic in your environment of choice\n- Securely store these traces as test suites\n- Analyze deviations (classification of intended vs unintended deviations), root cause of deviations against your code changes, and suggested fixes.\n\nIf you used `tusk drift setup`, cloud configuration is included. Otherwise, run the cloud onboarding wizard:\n\n```bash\ntusk drift init-cloud\n```\n\nFor more details, dive into [Tusk Drift Cloud docs](./docs/cloud/).\n\n## Usage\n\nList traces:\n\n```bash\n# Local traces\ntusk drift list\ntusk drift list --trace-dir .tusk/traces\n\n# With Tusk Drift Cloud\ntusk drift list --cloud\n```\n\nInteractive TUI (default when attached to a terminal):\n\n```bash\ntusk drift run\n\n# Run against Tusk Drift Cloud\ntusk drift run --cloud\ntusk drift run --cloud --trace-test-id \u003cid\u003e           # single test from backend\ntusk drift run --cloud --all-cloud-trace-tests        # run all tests for service\n```\n\nThe TUI is best viewed in a window size of at least 150 x 40.\n\nRun headless mode with JSON output for a single test:\n\n```bash\ntusk drift run --trace-id \u003cid\u003e --print --output-format=json\n```\n\nHow this program uses your `.tusk` directory:\n\n- Recordings of your app's traffic will be stored in `.tusk/traces` by default.\nSpecify `traces.dir` in your `.tusk/config.yaml` to override.\n- If `--save-results` is provided, results will be stored in `.tusk/results` by default. Specify `results.dir` in your `.tusk/config.yaml` to override.\n- If `--enable-service-logs` or `--debug` is used, trace replay service logs will be stored in `.tusk/logs`.\n\nWe recommend adding to your `.gitignore`:\n\n- `.tusk/results`\n- `.tusk/logs`\n- `.tusk/setup`\n- `.tusk/traces` (if you primarily intend to use Tusk Drift Cloud)\n\n## Resources\n\n- [Architecture overview](docs/architecture.md)\n- [Configuration](docs/configuration.md)\n- [Troubleshooting](docs/troubleshooting.md)\n\n## Community\n\nJoin our open source community on [Slack](https://join.slack.com/t/tusk-community/shared_invite/zt-3fve1s7ie-NAAUn~UpHsf1m_2tdoGjsQ).\n\n## Development\n\nSee [`CONTRIBUTING.md`](./CONTRIBUTING.md).\n\n## License\n\nSee [`LICENSE`](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuse-tusk%2Ftusk-drift-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fuse-tusk%2Ftusk-drift-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuse-tusk%2Ftusk-drift-cli/lists"}