Skip to main content
Before you begin, make sure that you have either:
  • GitHub user permissions to manage external apps in your GitHub organization
  • Maintainer or Owner role in your GitLab group while on the GitLab Premium or Ultimate plan (plans not required for GitLab Self-Managed)

​
Creating 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, a Tusk organization for your company will be created. Note that any team member who signs up via Google with your company’s email domain, or with GitHub/GitLab and have an active Tusk seat will automatically be added to the Tusk company organization. Tusk login page with Google, GitHub, and GitLab auth options

​
Connect version control platform

  • Connect GitHub
  • Connect GitLab
1

Navigate to Integrations

After clicking out of the onboarding modal, you should be in the Integrations page. Click Connect to authorize GitHub.Connect GitHub in Settings
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

​
Sync your repo(s)

1

Select repositories to enable

Upon successful authorization, you’ll be redirected to the Repositories page in Tusk. Click Enable on the repositories that you want to enable Tusk for.Repo selected in Settings
2

Wait for activation

Wait around 1 minute for the repo(s) to be enabled. During this time, Tusk will also set up a test execution environment where the agent can self-lint and run the tests it generates.Repo selected in Settings
3

Complete set-up

If additional one time set-up is required, our team will reach out to you with next steps. We will resolve the last-mile issues with the test execution environment (e.g., missing environment variables, missing dependencies).Repo selected in SettingsIf environment variables are required, you will be instructed to add them securely to Tusk by clicking the gear icon on the repository, going to the Environment Variables tab, and clicking Add Variable.Repo selected in SettingsTurnaround time is typically 1-2 days but can be longer for more complex set-ups. Contact support@usetusk.ai if you have any questions.

​
Set up a test execution environment

If you have a white-glove onboarding with the Tusk team, you can skip this section and speak to your Tusk point of contact about this.
1

Start setup

In the Repositories page, click Start setup on the repo card of your choice.
2

Create workflow file

Go through the setup wizard to create a Tusk test runner workflow file.
Refer to the self-serve guide for full instructions on setting up a test execution environment.

​
Connect project management platform (optional)

Tusk can use information and business logic from tickets linked to your pull requests to generate more relevant and accurate tests. Integrations page
  • Connect Linear
  • Connect Jira
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.

​
FAQs

Make sure the additional repo(s) are in the same GitHub organization. If not, see the 3rd frequently asked question.If you’ve already given Tusk access to “All repositories” on initial GitHub connection:
  1. Go to Settings > GitHub in the Tusk web app
  2. Check the additional repo(s) that you want to sync
  3. Click Save changes 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
  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 the Tusk web app, go to Settings > GitHub
  7. Click Update repos in the Repositories section
  8. Check the additional repo(s) that you want to sync
  9. Click Save changes to sync the additional repo(s)
  1. In GitHub itself, go to Settings > GitHub Apps for the current organization
  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
  2. Click Configure for “Use Tusk”
  3. Click Uninstall in the “Danger zone”
Once you have synced your repo(s), the Tusk team will set up a config on our end for the agent to be able to run the generated tests in an isolated, ephemeral sandbox. This config is unique to your organization and takes into account your dependencies.Turnaround is typically one day. We do this so that Tusk can show you the test results and auto-iterate on its test cases if the agent encounters an error.