How to Use Tusk

Getting started with Tusk

In this guide, you'll learn how to set up Tusk and create your first test and pull request from a ticket. By following these steps, you'll streamline your coding workflow and reduce repetitive tasks.

Step 1: Sign up and set up

1. Go to usetusk.ai.
2. Click on the "Sign Up" button in the top right corner.
3. Fill in the required fields with your email and password, then click "Create Account".
4. Confirm your email address by clicking the link in the verification email sent to you.
5. Log in to your new account.

Step 2: Your first test and pull request

1. Once logged in, navigate to the "Dashboard".
2. Click on the "New Ticket" button to create a ticket for your task.
3. Fill in the ticket details, including the task description and any specific requirements.
4. After saving the ticket, locate it in your list and click on it to open.
5. Click the "Generate Test" button. Tusk will analyse the ticket and create test cases based on the description.
6. Review the generated tests. If satisfied, click the "Create Pull Request" button.
7. Fill in any additional information required for the pull request and click "Submit".

Step 3: Get better results

• Ensure your ticket descriptions are clear and detailed. Include any edge cases or specific scenarios you want to cover in tests.
• Use the "Edit Ticket" option to refine your requirements after generating tests if needed.
• Explore the "Settings" menu to adjust the complexity level of generated tests based on your codebase.

Pro tip

Use Tusk's "Recursive Agent" feature for larger projects. It analyses the codebase more comprehensively, ensuring that the tests it generates are more accurate and relevant to your application’s structure.

Common mistake to avoid

Avoid vague ticket descriptions. The quality of generated tests depends heavily on how well you articulate the requirements in the ticket. Always be specific to get the best results quickly.