Skip to content

Commit f53830b

Browse files
authored
Merge pull request github#28164 from github/quickstart
Copilot Quickstart
2 parents eeba666 + dd31217 commit f53830b

11 files changed

+74
-7
lines changed
116 KB
Loading
72.3 KB
Loading
6.72 KB
Loading
11.8 KB
Loading
6.01 KB
Loading

content/copilot/quickstart.md

Lines changed: 68 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,75 @@
11
---
22
title: Quickstart for GitHub Copilot
3-
intro: 'ADD INTRO.'
3+
intro: '{% data variables.product.prodname_copilot %} can help you work, by offering inline suggestions as you code.'
4+
product: '{% data reusables.gated-features.copilot %}'
45
allowTitleToDifferFromFilename: true
56
versions:
67
feature: 'copilot'
78
shortTitle: Quickstart
8-
topics:
9+
topics:
910
- Copilot
10-
---
11+
---
12+
13+
## Introduction
14+
15+
{% data variables.product.prodname_copilot %} is an AI pair programmer. You can use {% data variables.product.prodname_copilot %} to get suggestions for whole lines or entire functions right inside your editor.
16+
17+
This guide will show you how to sign up for {% data variables.product.prodname_copilot %}, install the {% data variables.product.prodname_copilot %} extension in {% data variables.product.prodname_vscode %}, and get your first suggestion. For more information on {% data variables.product.prodname_copilot %}, see "[About {% data variables.product.prodname_copilot %}](/copilot/overview-of-github-copilot/about-github-copilot)." For more in-depth information on how to use {% data variables.product.prodname_copilot %} in a variety of environments, see "[Getting Started](/copilot/getting-started-with-github-copilot)."
18+
19+
## Prerequisites
20+
21+
{% data reusables.copilot.copilot-prerequisites %}
22+
- To use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}, you must have {% data variables.product.prodname_vscode %} installed. For more information, see the [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) documentation.
23+
24+
## Signing up for {% data variables.product.prodname_copilot %}
25+
26+
Before you can start using {% data variables.product.prodname_copilot %}, you will need to set up a free trial or subscription.
27+
28+
{% data reusables.user-settings.access_settings %}
29+
1. In the "Code, planning, and automation" section of the sidebar, click **GitHub Copilot**.
30+
2. On the {% data variables.product.prodname_copilot %} settings page, click **Start your free trial**.
31+
![Screenshot of GitHub Copilot settings with start your free trial button emphasized](/assets/images/help/copilot/copilot-settings-start-trial-button.png)
32+
3. Choose whether you want to pay monthly or yearly, and click **Continue to get access to Copilot**.
33+
- If your personal account meets the criteria for a free {% data variables.product.prodname_copilot %} subscription instead of a trial, you will automatically be taken to step 6.
34+
![Screenshot of trial setup with Continue to get access to Copilot button emphasized](/assets/images/help/copilot/copilot-billing-cycle.png)
35+
4. Confirm your payment details.
36+
5. Select your preferences, then click **Save and get started**.
37+
38+
## Installing the {% data variables.product.prodname_copilot %} extension for {% data variables.product.prodname_vscode %}
39+
40+
To use {% data variables.product.prodname_copilot %}, you must first install the {% data variables.product.prodname_vscode %} extension.
41+
42+
1. In the {% data variables.product.prodname_vscode %} Marketplace, go to the [{% data variables.product.prodname_copilot %} extension](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot) page and click **Install**.
43+
![Install {% data variables.product.prodname_copilot %} extension {% data variables.product.prodname_vscode %}](/assets/images/help/copilot/install-copilot-extension-visual-studio-code.png)
44+
1. A popup will appear, asking to open {% data variables.product.prodname_vscode %}. Click **Open {% data variables.product.prodname_vscode %}**.
45+
1. In the "Extension: {% data variables.product.prodname_copilot %}" tab in {% data variables.product.prodname_vscode %}, click **Install**.
46+
![Install button in {% data variables.product.prodname_vscode %}](/assets/images/help/copilot/in-visual-studio-code-install-button.png)
47+
1. If you have not previously authorized {% data variables.product.prodname_vscode %} in your {% data variables.product.prodname_dotcom %} account, you will be prompted to sign in to {% data variables.product.prodname_dotcom %} in {% data variables.product.prodname_vscode %}.
48+
- If you have previously authorized {% data variables.product.prodname_vscode %} in your {% data variables.product.prodname_dotcom %} account, {% data variables.product.prodname_copilot %} will be automatically authorized.
49+
![Screen shot of {% data variables.product.prodname_vscode %} authorization screen](/assets/images/help/copilot/vsc-copilot-authorize.png)
50+
1. In your browser, {% data variables.product.prodname_dotcom %} will request the necessary permissions for {% data variables.product.prodname_copilot %}. To approve these permissions, click **Authorize {% data variables.product.prodname_vscode %}**.
51+
1. In {% data variables.product.prodname_vscode %}, in the "{% data variables.product.prodname_vscode %}" dialogue box, to confirm the authentication, click **Open**.
52+
53+
## Getting your first suggestion
54+
55+
{% data reusables.copilot.supported-languages %} The following samples are in JavaScript, but other languages will work similarly.
56+
57+
1. Open {% data variables.product.prodname_vscode %}.
58+
{% data reusables.copilot.create-js-file %}
59+
{% data reusables.copilot.type-function-header %}
60+
{% data variables.product.prodname_copilot %} will automatically suggest an entire function body in grayed text, as shown below. The exact suggestion may vary.
61+
![First suggestion {% data variables.product.prodname_vscode %}](/assets/images/help/copilot/first-suggestion-visual-studio-code.png)
62+
{% data reusables.copilot.accept-suggestion %}
63+
64+
## Next Steps
65+
66+
You successfully installed {% data variables.product.prodname_copilot %} and received your first suggestion, but that's just the beginning! Here are some helpful resources for taking your next steps with {% data variables.product.prodname_copilot %}.
67+
68+
- [Getting Started](/copilot/getting-started-with-github-copilot): You've learned how to get your first suggestion in {% data variables.product.prodname_vscode %}. These guides show you how to set up and navigate the various functions of {% data variables.product.prodname_copilot %} across all of the supported environments.
69+
- [{% data variables.product.prodname_copilot %}](https://copilot.github.com/): See practical examples of how {% data variables.product.prodname_copilot %} can help you work.
70+
- [Configuring {% data variables.product.prodname_copilot %}](/copilot/configuring-github-copilot): These guides provide details on how to configure {% data variables.product.prodname_copilot %} to your personal preferences.
71+
72+
73+
## Further reading
74+
75+
- [About {% data variables.product.prodname_copilot %}](/copilot/overview-of-github-copilot/about-github-copilot)
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1. To accept the suggestion, press <kbd>Tab</kbd>.
1+
1. To accept the suggestion, press <kbd>Tab</kbd>.
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
- {% data variables.product.prodname_copilot %} is free to use for verified students and open source maintainers.
2+
- If you are not a student or open source maintainer, you can try {% data variables.product.prodname_copilot %} for free with a one-time 60 day trial. After the free trial, you will need a paid subscription for continued use. You must provide billing information in order to start a free trial. For more information, see "[About billing for {% data variables.product.prodname_copilot %}](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot)."
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1. Create a new JavaScript (_*.js_) file.
1+
1. Create a new JavaScript (_*.js_) file.

data/reusables/copilot/type-function-header.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22

33
```javascript{:copy}
44
function calculateDaysBetweenDates(begin, end) {
5-
```
5+
```
6+

0 commit comments

Comments
 (0)