
GitHub Copilot can help you work, by offering inline suggestions as you code.
GitHub Copilot can be managed through personal accounts with GitHub Copilot for Individuals or through organization accounts with GitHub Copilot for Business.
GitHub Copilot is free to use for verified students, teachers, and maintainers of popular open source projects. If you are not a student, teacher, or maintainer of a popular open source project, you can try GitHub Copilot for free with a one-time 60-day trial. After the free trial, you will need a paid subscription for continued use. For more information, see "About billing for GitHub Copilot."
Introduction
GitHub Copilot is an AI pair programmer. You can use GitHub Copilot to get suggestions for whole lines or entire functions right inside your editor.
This guide will show you how to set up a GitHub Copilot subscription for your personal or organization account, install the GitHub Copilot extension in Visual Studio Code, and get your first suggestion. For more information on GitHub Copilot, see "About GitHub Copilot for Individuals." For more in-depth information on how to use GitHub Copilot in a variety of environments, see "Getting started with GitHub Copilot."
Signing up for GitHub Copilot for your personal account
Before you can start using GitHub Copilot, you will need to set up a free trial or subscription for your personal account.
Note: If you were part of the free GitHub Copilot technical preview that was run between July 2021 and June 2022, you are not eligible for a 60-day trial.
In the upper-right corner of any page, click your profile photo, then click Settings.
In the "Code, planning, and automation" section of the sidebar, click GitHub Copilot.
On the GitHub Copilot settings page, click Enable GitHub Copilot.
- If your personal account meets the criteria for a free GitHub Copilot subscription instead of a trial or paid subscription, you will automatically be taken to step 6.
Choose whether you want to pay monthly or yearly, and click Continue to get access to Copilot.
Follow the steps to confirm your payment details, then click Submit.
Select your preferences, then click Save and get started.
You can change these preferences at a later time by returning to your GitHub Copilot settings. For more information, see "Configuring GitHub Copilot in your environment."
Note: As a member of an organization owned by a GitHub Enterprise Cloud account with a GitHub Copilot subscription, you must be assigned a GitHub Copilot seat by your organization before you can use GitHub Copilot.
Signing up for GitHub Copilot for your organization account
Before you can start using GitHub Copilot in your organization account, you will need to set up a subscription.
Go to the GitHub Copilot for Business sign up page.
Select an organization for which you want to purchase GitHub Copilot and click Continue.
Follow the steps to confirm your payment details, then click Save.
If you don't have a payment method on file, you'll be prompted to add one.
In the "Public code suggestions" dropdown, select Allow or Block to allow or block suggestions that match public code, and click Save and continue. You can change these preferences later by returning to your GitHub Copilot settings.
- If you selected Allow for all members, click Confirm in the "Confirm seat assignment" dialog to confirm that you want to enable GitHub Copilot for all current and future users in your organization.
- If you selected Selected teams/users, you can choose Add people or Add team.
- If you selected Add people, in the "Enable GitHub Copilot access for selected members of ORGANIZATION" dialog, you can either search for individual members, or you can add members in bulk by uploading a CSV file.
- If you selected Add team, in the "Enable GitHub Copilot access for selected teams of ORGANIZATION" dialog, start typing the team name in the search bar, select the team you want to add and click Add team(s) to access list.
Either grant access to GitHub Copilot for all current and future users in your organization, or for specific users in your organization.
To finish setting up your GitHub Copilot for Business subscription, click Save and finish. Organization members will receive an email with instructions on how to start using GitHub Copilot.
Installing the GitHub Copilot extension for Visual Studio Code
To use GitHub Copilot, you must first install the Visual Studio Code extension.
In the Visual Studio Code Marketplace, go to the GitHub Copilot extension page and click Install.
A popup will appear, asking to open Visual Studio Code. Click Open Visual Studio Code.
In the "Extension: GitHub Copilot" tab in Visual Studio Code, click Install.
- If you have previously authorized Visual Studio Code in your GitHub account, GitHub Copilot will be automatically authorized.
If you have not previously authorized Visual Studio Code in your GitHub account, you will be prompted to sign in to GitHub in Visual Studio Code.
In your browser, GitHub will request the necessary permissions for GitHub Copilot. To approve these permissions, click Authorize Visual Studio Code.
In Visual Studio Code, in the "Visual Studio Code" dialogue box, to confirm the authentication, click Open.
Getting your first suggestion
Note: If you have duplication detection enabled for GitHub Copilot, you may receive limited suggestions, or no suggestions, when using the code examples provided. As an alternative, you can start by typing your own code to see suggestions from GitHub Copilot. For more information on duplication detection, see "Configuring GitHub Copilot settings on GitHub.com."
GitHub Copilot provides suggestions for numerous languages and a wide variety of frameworks, but works especially well for Python, JavaScript, TypeScript, Ruby, Go, C# and C++. The following samples are in JavaScript, but other languages will work similarly.
Open Visual Studio Code.
In Visual Studio Code, create a new JavaScript (*.js) file.
- JavaScript
In the JavaScript file, type the following function header.
GitHub Copilot will automatically suggest an entire function body in grayed text. The exact suggestion may vary.
To accept the suggestion, press Tab.
Next Steps
You successfully installed GitHub Copilot and received your first suggestion, but that's just the beginning! Here are some helpful resources for taking your next steps with GitHub Copilot.
- Getting started with GitHub Copilot: You've learned how to get your first suggestion in Visual Studio Code. These guides show you how to set up and navigate the various functions of GitHub Copilot across all of the supported environments.
- GitHub Copilot: See practical examples of how GitHub Copilot can help you work.
- Configuring GitHub Copilot: These guides provide details on how to configure GitHub Copilot to your personal preferences.