How to Use Augment Code

Getting started with Augment Code

After reading this guide, you will be able to set up Augment Code and use it to assist with your coding tasks in complex codebases.

Step 1: Sign up and set up

1. Visit Augment Code.
2. Click on the Sign Up button located at the top right corner of the homepage.
3. Fill in the required information (email, password) and click Create Account.
4. Check your email for a verification link and follow the instructions to activate your account.
5. Once verified, log in to your account.

Step 2: Your first code assistance

1. After logging in, you’ll see the dashboard. Click on New Project.
2. Enter your project name and select the programming language you are using.
3. Upload your codebase by clicking the Upload Code button and selecting the relevant files or folder.
4. Once the upload is complete, click on the Open Editor option.
5. In the editor, enter your query or code requirement in the prompt area. For example, "Explain this function" or "Suggest improvements for performance."
6. Click on the Submit button to receive suggestions or explanations from the AI.

Step 3: Get better results

1. Use specific prompts to get the best results. Instead of asking vague questions, specify the function or section of code you want help with.
2. If working with a large codebase, consider breaking down your queries into smaller parts to receive more focused assistance.
3. Explore the Settings menu to adjust preferences for how suggestions are displayed, such as enabling code comments or examples.

Pro tip

Regularly save your sessions by using the Save Project option in the toolbar. This allows you to return to your work without losing progress.

Common mistake to avoid

Avoid uploading your entire monorepo at once without filtering out unnecessary files. This can lead to slower processing times and less relevant suggestions. Focus on the specific components you need assistance with.