Quickstart: Installing, using features in GitHub, and increasing usage limits - Amazon Q Developer
Step 1: Install Amazon Q Developer in GitHub and authorize accessStep 2: Using Amazon Q Developer features in GitHubStep 3: Increase free usage limits and configure details

Quickstart: Installing, using features in GitHub, and increasing usage limits

Note

Amazon Q Developer for GitHub is in preview release and is subject to change.

This tutorial provides a walkthrough of the following tasks:

  1. Install the Amazon Q Developer app from the GitHub Marketplace and provide access to your repositories.

  2. Get started with Amazon Q Developer in an issue by adding a label for either feature development or code transformation, or by creating a new pull request for code review. Alternatively, you can use slash commands in issues to initiate feature development or code transformation. You can also initiate additional code reviews within pull requests with a slash command.

  3. (Optional) Register your Amazon Q Developer app installation with your AWS account to increase your usage limits.

Step 1: Install Amazon Q Developer in GitHub and authorize access

You can use Amazon Q Developer in GitHub free without the need to set up an AWS account to get started. The first step to using Amazon Q Developer in GitHub is to install the app from GitHub . During this process, you can provide Amazon Q Developer access to all your GitHub repositories or selected repositories.

Important

To install the Amazon Q Developer app and authorize access to GitHub repositories, you must meet the requirements for the GitHub organization. For more information, see Requirements to install a GitHub App and Roles in organization in the GitHub documentation.

To install Amazon Q Developer and authorize access

  1. Navigate to the Amazon Q Developer for GitHub app page.

  2. If necessary, sign in to your GitHub account using your GitHub credentials.

  3. Review the Amazon Q Developer app's overview and features, and then choose Install.

  4. Do one of the following to configure access to your GitHub repositories:

    1. To provide access to all current and future repositories, choose All repositories.

    2. To provide access to specific repositories, choose Only select repositories, choose the Select repositories dropdown, and then choose a repository you want to allow to access to.

  5. Choose Install to complete installing Amazon Q Developer in GitHub and authorizing it to access your repositories.

After installing the app in GitHub and authorizing access, you're redirected to the Amazon Q Developer overview page in GitHub. You can navigate to your GitHub repository to begin using the Amazon Q Developer features.

Note

If your GitHub enterprise organization has enabled IP allowlisting, you must accept the allowed IP addresses on the GitHub app. You can also choose to automatically add the IP addresses to your allow list. For more information, see Allowing access by GitHub Apps and Enabling allowed IP addresses in the GitHub documentation.

The following IP addresses are used to access your GitHub resources:

34.228.181.128
44.219.176.187
54.226.244.221

Step 2: Using Amazon Q Developer features in GitHub

After installing the Amazon Q Developer app in GitHub and authorizing access to your repositories, you can begin using the Amazon Q Developer agents for support across the software development lifecycle from coding, testing, and deploying to troubleshooting and modernizing applications. For more information, see one of the following:

Important

The Amazon Q Developer app attempts to automatically create the Amazon Q development agent and the Amazon Q transform agent labels in GitHub repositories you authorize access to. If the labels are not automatically created, or if they're unintentionally deleted, you can manually create them in GitHub. The labels must be named as Amazon Q development agent and Amazon Q transform agent in order for them to be recognized and processed as Amazon Q Developer labels. For more information, see Creating a label in the GitHub documentation.

Step 3: Increase free usage limits and configure details

You can use Amazon Q Developer agents in GitHub for free without the need to set up an AWS account to get started. You're provided with limited invocations per month for feature development and code review, as well as limited number of lines of code transformation per month. You can increase your free usage at any time by registering your Amazon Q Developer app installation with your AWS account. Registering also provides with the ability to configure details such as disabling code reviews and adding tags for searching and filtering. For more information, see Increasing usage limits and configuring details in Amazon Q Developer console.

Important

To register the app installation in the Amazon Q Developer console, you must meet the requirements for the GitHub organization. For more information, see Requirements to install a GitHub App and OAuth apps and organizations in the GitHub documentation.