Get Started
Onboarding
Set your team up on Tusk in 2 minutes
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
- Log in to Tusk (https://app.usetusk.ai) with Google or with email/password. Team members who sign up via Google with your company’s email domain will automatically be added to the organization.
Connect your GitHub organization
1
Navigate to Integrations
After clicking out of the onboarding modal, you should be in the Integrations page. Click Connect to authorize GitHub.
2
Select organization
Click on your GitHub organization.
3
Configure repository access
Choose whether to authorize all repositories or only select repositories in your organization. Click Install.
Connect your GitLab group/project
Setting up GitLab for Tusk takes a few minutes of manual work due to limitations with the GitLab API. Please reach out to Support if you have any questions.1
Go to Settings > Integrations
You should see the GitLab integration in the list of code hosting platforms supported. Click Connect.
2
Navigate to GitLab Group
You will see a page with instructions on how to connect your GitLab group or project to Tusk.
If you have a self-hosted GitLab instance, fill in the GitLab host URL as per the instructions. Otherwise, you can leave this field blank.
If you have a self-hosted GitLab instance, fill in the GitLab host URL as per the instructions. Otherwise, you can leave this field blank.3
Create Access Token
Go to GitLab. In the left sidebar of your group or project, select Settings > Access tokens. Click Add new token.
Create a Group Access Token or Project Access Token with the details below.
We recommend using a Group Access Token so you don’t need to repeat this setup when adding additional projects.
Create a Group Access Token or Project Access Token with the details below.- Name: Tusk
- Expiry date: Set as far in the future as possible (max 1 year)
- Role: Developer
- Scopes: api, read_repository, write_repository
4
Add access token to Tusk
After creating the access token, copy the access token immediately.
Go back into the Tusk web app and paste the access token into the Access Token field.
You will not be able to access the token again once you leave this page.
Go back into the Tusk web app and paste the access token into the Access Token field.5
Create a webhook
Return to the GitLab group or project and go to Settings > Webhooks in the left sidebar. Click Add new webhook.
Create a webhook in GitLab with the details below.
Create a webhook in GitLab with the details below.- URL:
https://use-tusk.uc.r.appspot.com/api/webhook/gitlab - Secret token: Copy the auto-generated secret token from Tusk’s GitLab flow and paste it in this field
- Trigger:
Push events(all branches),Comments,Issues events,Merge request events,Emoji events
6
Confirm webhook creation in Tusk
Return to the Tusk web app and check the checkbox that says “I have created a webhook with the above configuration”.
Click Connect GitLab after to complete the integration.
Click Connect GitLab after to complete the integration.Sync your repos
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.
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.
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).
If 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.
Turnaround time is typically 1-2 days but can be longer for more complex set-ups. Contact support@usetusk.ai if you have any questions.
If 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.Turnaround time is typically 1-2 days but can be longer for more complex set-ups. Contact support@usetusk.ai if you have any questions.Connect your project management platform
Tusk can use information and business logic from tickets linked to your pull requests to generate more relevant and accurate tests.
Connecting to Linear
- Under the Integrations tab, find the Linear integration card under “Project management platform.” Click Connect.
- 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.
- Click Authorize Tusk once you have confirmed that you’re in the correct workspace.
- 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.
Connecting to Jira
- Under the Integrations tab, find the Jira integration card under “Project management platform.” Click Connect.
- You’ll be redirected to the Atlassian platform to grant Tusk access to your Jira site.
- Choose the correct Jira site under “Authorize for site” and click Accept.
- You’ll then be redirected back to the Tusk app, where you should now see a status badge displaying “Connected” on the Jira integration card.
FAQs
How do I sync additional repos to Tusk?
How do I sync additional repos to Tusk?
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:
- Go to Settings > GitHub in the Tusk web app
- Check the additional repo(s) that you want to sync
- Click Save changes to sync the additional repo(s)
I still don't see my other repos in the same organization. What's happening?
I still don't see my other repos in the same organization. What's happening?
You most likely gave Tusk access to “Only select repositories” on initial GitHub connection.
- In GitHub itself, go to Settings > GitHub Apps for the current organization
- Click Configure for “Use Tusk”
- Under Repository access, click Select repositories
- Select the additional repo(s) from the dropdown menu
- Click Save
- In the Tusk web app, go to Settings > GitHub
- Click Update repos in the Repositories section
- Check the additional repo(s) that you want to sync
- Click Save changes to sync the additional repo(s)
How do I connect another GitHub organization to Tusk?
How do I connect another GitHub organization to Tusk?
- In GitHub itself, go to Settings > GitHub Apps for the current organization
- Click Configure for “Use Tusk”
- Click Uninstall in the “Danger zone”
- Return to the Tusk web app’s settings
- Click Connect on the GitHub integration
- Select the new GitHub organization to authorize Tusk on
How do I disconnect my GitHub organization from Tusk?
How do I disconnect my GitHub organization from Tusk?
- In GitHub itself, go to Settings > GitHub Apps for the current organization
- Click Configure for “Use Tusk”
- Click Uninstall in the “Danger zone”
How does Tusk self-run the tests it generates?
How does Tusk self-run the tests it generates?
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.