Skip to main content
Before you begin, make sure that you have these permissions:
GitHub user permissions to manage external apps in your GitHub organization

​
Creating an organization

1

Create an account

Sign up to Tusk with Google, GitHub, GitLab, or with email/password. If you create an account with your company’s Google Workspace, Tusk will create an organization for your company.Tusk login page with Google, GitHub, and GitLab auth optionsNote: Any team member who signs up via Google with your company’s email domain, or with GitHub/GitLab and who are in your GitHub/GitLab organization will automatically be added to the Tusk company organization.
2

Enter profile details

Fill out your profile and organization details to personalize your experience.Onboarding wizard step 1
3

Choose use case

Select your primary use case. This directs you to your ideal onboarding flow.Onboarding wizard step 1

​
Connect version control platform

1

Select GitHub in screen

Click the GitHub card in the onboarding wizard.Onboarding wizard step 1
2

Select organization

Click on your GitHub organization.Onboarding Guide 3
3

Configure repository access

Choose whether to authorize all repositories or only select repositories in your organization. Click Install.Onboarding Guide 4
4

Analyze repos for eligiblity

Choose up to 3 repos in your organization you’d like Tusk to start the setup process for. Click Continue.Onboarding Guide 4
5

Complete onboarding wizard

You’ll be directed to the Repos page where you’ll see the selected repos be analyzed for their eligibility for unit test generation and API drift detection.Onboarding Guide 4

​
Connect project management platform (optional)

Tusk can use business context from tickets linked to your pull requests to generate more relevant unit tests and classify API deviations more accurately. Integrations page

1

Connect Linear

Under the Integrations tab, find the Linear integration card under “Project management platform.” Click Connect.
2

Grant access

You’ll be redirected to the Linear app to grant Tusk access to your Linear workspace. Make sure to choose the correct workspace on the top left corner.Authorize Linear
3

Authorize Tusk

Click Authorize Tusk once you have confirmed that you’re in the correct workspace.
4

Confirm connection

You’ll then be redirected back to the Tusk app, where you should now see a status badge displaying “Connected” on the Linear integration card.

​
Next Steps

  • API Drift Detection: follow this guide to install the Tusk Drift CLI and SDK in two commands to record/replay traces as API tests.
  • Unit Test Generation: follow this guide to set up a test execution environment to generate and run unit tests in your PRs.

​
FAQs

Make sure the additional repo(s) are in the same GitHub organization. If not, see the frequently asked question below this one. If you’ve already given Tusk access to the repo in GitHub, follow these steps:
  1. Go to Connected Repos in the Tusk web app
  2. Click Sync connected repos
If also enabling unit test generation on the new repo(s):
  1. Go to the Unit Tests page
  2. Click Enable to sync the additional repo(s)
You most likely gave Tusk access to “Only select repositories” on initial GitHub connection.
  1. In GitHub itself, go to Settings > GitHub Apps for the current organization (github.com/organizations/your-org-name/settings/installations)
  2. Click Configure for “Use Tusk”
  3. Under Repository access, click Select repositories
  4. Select the additional repo(s) from the dropdown menu
  5. Click Save
  6. In Tusk, go to Connected Repos and click Sync connected repos
If also enabling unit test generation on the new repo(s):
  1. Go to the Unit Tests page
  2. Click Enable to sync the additional repo(s)
  1. In GitHub itself, go to Settings > GitHub Apps for the current organization (github.com/organizations/your-org-name/settings/installations)
  2. Click Configure for “Use Tusk”
  3. Click Uninstall in the “Danger zone”
  4. Return to the Tusk web app’s settings
  5. Click Connect on the GitHub integration
  6. Select the new GitHub organization to authorize Tusk on
  1. In GitHub itself, go to Settings > GitHub Apps for the current organization (github.com/organizations/your-org-name/settings/installations)
  2. Click Configure for “Use Tusk”
  3. Click Uninstall in the “Danger zone”
Tusk runs generated tests in isolated, ephemeral sandboxes using your test execution environment configuration. When you set up a test environment, Tusk creates a Docker-based sandbox specifically configured for your project’s dependencies and testing framework.This allows Tusk to:
  • Verify that generated tests actually pass
  • Auto-iterate on test cases if errors are encountered
  • Show you test results before you incorporate them into your codebase
See Test Execution Environments for more details on how this works.