8000 Repo sync by docs-bot · Pull Request #33187 · github/docs · GitHub
[go: up one dir, main page]

Skip to content

Repo sync #33187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
May 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions content/copilot/about-github-copilot.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,20 @@ For a full list of the features and functionality available on each {% data vari

## Getting access to {% data variables.product.prodname_copilot %}

You can access {% data variables.product.prodname_copilot %} as part of one of the following paid plans.
You can access {% data variables.product.prodname_copilot %} as part of one of the following paid plans:

- **{% data variables.product.prodname_copilot_individuals_short %}** - Get access to {% data variables.product.prodname_copilot %} in an IDE, or on the command line, for your personal or independent use. You can <a href="https://github.com/github-copilot/signup?ref_cta=Copilot+trial&ref_loc=about+github+copilot&ref_page=docs" target="_blank"><span>try {% data variables.product.prodname_copilot %} for free</span></a> with a one-time 30-day trial. After the free trial, you will need a paid subscription for continued use. For more information, see "[AUTOTITLE](/copilot/copilot-individual/about-github-copilot-individual)."

If you're a verified student, teacher, or maintainer of a popular open source project, {% data variables.product.prodname_copilot %} is free to use. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot)."

- **{% data variables.product.prodname_copilot_individuals_short %}** - Get access to {% data variables.product.prodname_copilot %} in an IDE, or on the command line, for your personal or independent use. For more information, see "[AUTOTITLE](/copilot/copilot-individual/about-github-copilot-individual)."
- **{% data variables.product.prodname_copilot_business_short %}** - Access {% data variables.product.prodname_copilot %} as a member of an organization. Owners of the organization can manage access for individual members or for teams. For more information, see "[AUTOTITLE](/copilot/copilot-business/about-github-copilot-business)."
- **{% data variables.product.prodname_copilot_enterprise_short %}** - In addition to accessing {% data variables.product.prodname_copilot_short %} in an IDE or on the command line, use {% data variables.product.prodname_copilot_short %} on {% data variables.product.prodname_dotcom_the_website %}. This includes the ability to:
- **{% data variables.product.prodname_copilot_enterprise_short %}** - Access {% data variables.product.prodname_copilot %} as a member of an enterprise. Enterprise owners can allow some or all organizations in the enterprise to access {% data variables.product.prodname_copilot %}. If an organization has access to {% data variables.product.prodname_copilot_short %}, owners of the organization can grant access to {% data variables.product.prodname_copilot_enterprise_short %} for some or all members of the organization. For more information, see "[AUTOTITLE](/copilot/github-copilot-enterprise/overview/about-github-copilot-enterprise)."

With {% data variables.product.prodname_copilot_enterprise_short %}, in addition to accessing {% data variables.product.prodname_copilot_short %} in an IDE or on the command line, you can use {% data variables.product.prodname_copilot_short %} on {% data variables.product.prodname_dotcom_the_website %}. This includes the ability to:

- Chat with {% data variables.product.prodname_copilot_short %} to get help with your code, or to ask general tech-related questions.
- Create tailored knowledge bases to use as the context for chat.
- Generate automatic summaries of pull requests.

For more information, see "[AUTOTITLE](/copilot/github-copilot-enterprise/overview/about-github-copilot-enterprise)."

{% data reusables.copilot.copilot-one-account-short %}
> [!NOTE]
> {% data reusables.copilot.copilot-one-account-short %}
8000
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Configuring GitHub Copilot in your environment
shortTitle: In your environment
shortTitle: Copilot in your environment
intro: 'You can enable, configure, or disable {% data variables.product.prodname_copilot %} in a supported IDE.'
product: '{% data reusables.gated-features.copilot %}'
redirect_from:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Configuring GitHub Copilot settings on GitHub.com
shortTitle: Copilot on GitHub.com
intro: 'You can change your personal settings on {% data variables.product.prodname_dotcom_the_website %} to configure {% data variables.product.prodname_copilot %}''s behavior. This affects how {% data variables.product.prodname_copilot %} functions in any supported IDE you use.'
product: '{% data reusables.gated-features.copilot %}'
permissions: 'People with individual {% data variables.product.prodname_copilot %} subscriptions can configure their settings on {% data variables.product.prodname_dotcom_the_website %}.'
Expand All @@ -10,7 +11,6 @@ versions:
redirect_from:
- /github/copilot/about-github-copilot-telemetry
- /github/copilot/github-copilot-telemetry-terms
shortTitle: GitHub.com
---

## About {% data variables.product.prodname_copilot %} settings on {% data variables.product.prodname_dotcom_the_website %}
Expand Down
1 change: 1 addition & 0 deletions content/copilot/configuring-github-copilot/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ topics:
children:
- /configuring-github-copilot-settings-on-githubcom
- /configuring-github-copilot-in-your-environment
- /installing-the-github-copilot-extension-in-your-environment
- /configuring-network-settings-for-github-copilot
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,168 @@
---
title: Installing the GitHub Copilot extension in your environment
shortTitle: Install Copilot extension
intro: 'To use {% data variables.product.prodname_copilot_short %} in your preferred coding environment, you must install the {% data variables.product.prodname_copilot %} extension.'
versions:
feature: copilot
defaultTool: vscode
topics:
- Copilot
---

{% azure_data_studio %}

Installing the {% data variables.product.prodname_copilot %} extension in Azure Data Studio allows you to receive coding suggestions from {% data variables.product.prodname_copilot_short %} as you type.

To see instructions for other popular coding environments, use the tool switcher at the top of the page.

## Installing the {% data variables.product.prodname_copilot %} extension in Azure Data Studio

1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see "[AUTOTITLE](/copilot/about-github-copilot#getting-access-to-github-copilot)."

1. Make sure you have a compatible version of Azure Data Studio. To use {% data variables.product.prodname_copilot %} in Azure Data Studio, you must have Azure Data Studio version 1.44.0 or later installed. See the [Azure Data Studio download page](https://docs.microsoft.com/sql/azure-data-studio/download-azure-data-studio) in the Azure Data Studio documentation.

1. Install the {% data variables.product.prodname_copilot %} extension in Azure Data Studio. See [Install the {% data variables.product.prodname_copilot %} extension](https://learn.microsoft.com/en-us/azure-data-studio/extensions/github-copilot-extension-overview#install-the-github-copilot-extension) in the Microsoft documentation.

1. If a popup window in Azure Data Studio prompts you to sign in to use {% data variables.product.prodname_copilot %}, click **Sign in to {% data variables.product.prodname_dotcom %}** and follow the instructions on screen.

- If you have previously authorized Azure Data Studio for your account on {% data variables.product.prodname_dotcom %}, {% data variables.product.prodname_copilot %} will be automatically authorized.
- If you don't get the prompt to authorize, you can view notifications by clicking the bell icon in the bottom panel of the Azure Data Studio window.

1. If you are following the authorization steps, 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 Azure Data Studio**.

{% endazure_data_studio %}

{% jetbrains %}

Installing the {% data variables.product.prodname_copilot %} extension in JetBrains IDEs allows you to receive coding suggestions from {% data variables.product.prodname_copilot_short %} as you type.

To see instructions for other popular coding environments, use the tool switcher at the top of the page.

## Installing the {% data variables.product.prodname_copilot %} plugin in your JetBrains IDE

The following procedure will guide you through installation of the {% data variables.product.prodname_copilot %} plugin in IntelliJ IDEA. Steps to install the plugin in another supported IDE may differ.

1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see "[AUTOTITLE](/copilot/about-github-copilot#getting-access-to-github-copilot)."

1. Make sure you have a JetBrains IDE that is compatible with {% data variables.product.prodname_copilot %}. {% data variables.product.prodname_copilot %} is compatible with the following IDEs:

- IntelliJ IDEA (Ultimate, Community, Educational)
- Android Studio
- AppCode
- CLion
- Code With Me Guest
- DataGrip
- DataSpell
- GoLand
- JetBrains Client
- MPS
- PhpStorm
- PyCharm (Professional, Community, Educational)
- Rider
- RubyMine
- RustRover
- WebStorm

For more information, see the [JetBrains IDEs](https://www.jetbrains.com/products/) tool finder.

1. Install the {% data variables.product.prodname_copilot %} plugin for JetBrains. See [{% data variables.product.prodname_copilot %} plugin](https://plugins.jetbrains.com/plugin/17718-github-copilot) in the JetBrains Marketplace.

1. After {% data variables.product.prodname_copilot %} is installed, click **Restart IDE**.

1. After your JetBrains IDE has restarted, click the **Tools** menu. Click **{% data variables.product.prodname_copilot %}**, then click **Login to {% data variables.product.prodname_dotcom %}**.

![Screenshot of the expanded "Tools 9E88 " menu and "{% data variables.product.prodname_copilot %}" sub-menu. The "Login to {% data variables.product.prodname_dotcom %}" option is highlighted in blue.](/assets/images/help/copilot/jetbrains-tools-menu.png)

1. In the "Sign in to {% data variables.product.prodname_dotcom %}" dialog box, to copy the device code and open the device activation window, click **Copy and Open**.

![Screenshot of the "Sign in to {% data variables.product.prodname_dotcom %}" dialog. A device code is displayed above a button labeled "Copy and Open".](/assets/images/help/copilot/device-code-copy-and-open.png)

1. A device activation window will open in your browser. Paste the device code, then click **Continue**.

1. {% 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_copilot %} Plugin**.

1. After the permissions have been approved, your JetBrains IDE will show a confirmation. To begin using {% data variables.product.prodname_copilot %}, click **OK**.

{% endjetbrains %}

{% vimneovim %}

Installing the {% data variables.product.prodname_copilot %} extension in Vim/Neovim allows you to receive coding suggestions from {% data variables.product.prodname_copilot_short %} as you type.

To see instructions for other popular coding environments, use the tool switcher at the top of the page.

## Installing the {% data variables.product.prodname_copilot %} extension in Vim/Neovim

{% data variables.product.prodname_dotcom %} recommends that you install the {% data variables.product.prodname_copilot %} plugin with Vim/Neovim's built-in plugin manager. Alternatively, you can use a plugin manager of your choice to install `github/copilot.vim`. For more information, see the [copilot.vim repository](https://github.com/github/copilot.vim).

1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see "[AUTOTITLE](/copilot/about-github-copilot#getting-access-to-github-copilot)."

1. Make sure you have a compatible version of Vim/Neovim installed. To use {% data variables.product.prodname_copilot %} in Vim/Neovim you must have Vim version 9.0.0185 / Neovim version 0.6 or above and Node.js version 18 or above. See the [Vim](https://vimhelp.org/) / [Neovim documentation](https://neovim.io/doc/) and the [Node.js website](https://nodejs.org/en/).

1. Install {% data variables.product.prodname_copilot %} using the built-in plugin manager:

- For **Vim on macOS or Linux**, run the following command in the terminal.

```shell copy
git clone https://github.com/github/copilot.vim \
~/.vim/pack/github/start/copilot.vim
```

- For **Vim on Windows**, run the following command in Git Bash:

```shell copy
git clone https://github.com/github/copilot.vim.git \
$HOME/vimfiles/pack/github/start/copilot.vim
```

- For **Neovim on macOS or Linux**, run the following command in the terminal.

```shell copy
git clone https://github.com/github/copilot.vim \
~/.config/nvim/pack/github/start/copilot.vim
```

- For **Neovim on Windows**, run the following command in Git Bash:

```shell copy
git clone https://github.com/github/copilot.vim.git \
$HOME/AppData/Local/nvim/pack/github/start/copilot.vim
```

{% data reusables.copilot.config-enable-copilot-in-vimneovim %}

{% endvimneovim %}

{% visualstudio %}

Installing the {% data variables.product.prodname_copilot %} extension in {% data variables.product.prodname_vs %} allows you to receive coding suggestions from {% data variables.product.prodname_copilot_short %} as you type.

To see instructions for other popular coding environments, use the tool switcher at the top of the page.

## Installing the {% data variables.product.prodname_copilot %} extension in {% data variables.product.prodname_vs %}

1. Make sure you have F438 access to {% data variables.product.prodname_copilot %}. For information, see "[AUTOTITLE](/copilot/about-github-copilot#getting-access-to-github-copilot)."

1. Make sure you have a compatible version of {% data variables.product.prodname_vs %} installed. To use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vs %}, you must have version 2022 17.6 or later of {% data variables.product.prodname_vs %} for Windows. Note that {% data variables.product.prodname_copilot_short %} is not currently available in {% data variables.product.prodname_vs %} for Mac. For more information, see "[Install {% data variables.product.prodname_vs %}](https://learn.microsoft.com/en-us/visualstudio/install/install-visual-studio)" in the Microsoft documentation.

1. Install the {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vs %} See "[Install GitHub Copilot in Visual Studio](https://learn.microsoft.com/en-us/visualstudio/ide/visual-studio-github-copilot-install-and-states)" in the Microsoft documentation.

1. After installing the {% data variables.product.prodname_copilot %} extension, to enable {% data variables.product.prodname_copilot %}, ensure you have added your {% data variables.product.prodname_dotcom %} account to {% data variables.product.prodname_vs %}. For more information, see [Add your {% data variables.product.prodname_dotcom %} accounts to your {% data variables.product.prodname_vs %} keychain](https://learn.microsoft.com/en-us/visualstudio/ide/work-with-github-accounts) in the Microsoft documentation.

{% endvisualstudio %}

{% vscode %}

Installing the {% data variables.product.prodname_copilot %} extension in {% data variables.product.prodname_vscode %} allows you to receive coding suggestions from {% data variables.product.prodname_copilot_short %} as you type. It also automatically installs the {% data variables.product.prodname_copilot_chat %} extension, which allows you to chat with {% data variables.product.prodname_copilot_short %}.

To see instructions for other popular coding environments, use the tool switcher at the top of the page.

## Installing the {% data variables.product.prodname_copilot %} extension in {% data variables.product.prodname_vscode %}

1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see "[AUTOTITLE](/copilot/about-github-copilot#getting-access-to-github-copilot)."

1. Install {% data variables.product.prodname_vscode %}. See the [{% data variables.product.prodname_vscode %} download page](https://code.visualstudio.com/Download).

1. Install the [{% data variables.product.prodname_copilot %} extension](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot) in {% data variables.product.prodname_vscode %}. For detailed instructions, see "[Set up {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/docs/copilot/setup)" in the {% data variables.product.prodname_vscode %} documentation.

{% endvscode %}
2 changes: 1 addition & 1 deletion content/copilot/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ introLinks:
quickstart: /copilot/quickstart
featuredLinks:
startHere:
- /copilot/using-github-copilot/getting-started-with-github-copilot
- /copilot/using-github-copilot/using-github-copilot-code-suggestions-in-your-editor
popular:
- /billing/managing-billing-for-github-copilot/about-billing-for-github-copilot
- /copilot/configuring-github-copilot/configuring-github-copilot-in-your-environment
Expand Down
4 changes: 2 additions & 2 deletions content/copilot/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ To use {% data variables.product.prodname_copilot %} in {% data variables.produc
{% data reusables.copilot.create-js-file %}
{% data reusables.copilot.type-function-header %}
{% data variables.product.prodname_copilot %} will automatically suggest an entire function body in grayed text. The exact suggestion may vary.
{% data reusables.copilot.accept-suggestion %}
1. {% data reusables.copilot.accept-suggestion %}

{% ifversion fpt %}

Expand Down Expand Up @@ -150,7 +150,7 @@ As an enterprise owner, you must decide whether to allow all organizations in yo

## Next steps

{% data reusables.copilot.next-steps %}
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 %}.

- "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization)": As an organization owner, learn how to grant access to {% ifversion ghec %}{% data variables.product.prodname_copilot_enterprise_short %} or{% endif %} {% data variables.product.prodname_copilot_business_short %} in your organization.
- "[AUTOTITLE](/copilot/using-github-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.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Finding public code that matches GitHub Copilot suggestions
shortTitle: Finding matching code
shortTitle: Find matching code
intro: 'If you allow {% data variables.product.prodname_copilot %} to make suggestions that match publicly available code, you can see references to the matching code on {% data variables.product.prodname_dotcom_the_website %}.'
redirect_from:
- /early-access/copilot/code-referencing-in-github-copilot
Expand Down
Loading
Loading
0