-
Notifications
You must be signed in to change notification settings - Fork 5.5k
Add instructions for using multiple GH accounts #9072
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
Changes from 3 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,7 +24,7 @@ There are different ways to get access to GitHub Copilot: | |
|
|
||
| To use Copilot in VS Code, you need access to a GitHub Copilot subscription. You can set up Copilot directly from within VS Code. | ||
|
|
||
| 1. Hover over the Copilot icon in the Status Bar and select **Set up Copilot**. | ||
| 1. Hover over the Copilot icon in the Status Bar and select **Use AI Features**. | ||
|
|
||
|  | ||
|
|
||
|
|
@@ -37,6 +37,16 @@ To use Copilot in VS Code, you need access to a GitHub Copilot subscription. You | |
|
|
||
| 1. You can now start using Copilot in VS Code. Learn the basics with the [Copilot Quickstart](/docs/copilot/getting-started.md). | ||
|
|
||
| ## Use Copilot with a GHE account | ||
|
|
||
| If your Copilot subscription is associated with a GitHub Enterprise (GHE) account, you can sign in to Copilot in VS Code with your GHE credentials. | ||
|
|
||
| 1. If you haven't already, hover over the Copilot icon in the Status Bar and select **Use AI Features**. | ||
|
|
||
| 1. In the sign in dialog, choose **Continue with GHE.com** and provide your GHE instance URL and credentials. | ||
|
|
||
| If you need to switch between a GitHub.com account and a GHE account, see [Use a different GitHub account per workspace or profile](#use-a-different-github-account-per-workspace-or-profile) for instructions. | ||
|
|
||
| ## Use a different GitHub account with Copilot | ||
|
|
||
| If your Copilot subscription is associated with another GitHub account, follow these steps to sign out of your GitHub account in VS Code, and sign in with another account. | ||
|
|
@@ -47,15 +57,46 @@ If your Copilot subscription is associated with another GitHub account, follow t | |
|
|
||
| 1. Sign in to your GitHub account using any of the following methods: | ||
|
|
||
| - Select **Sign in to use Copilot** from the Copilot menu in the Status Bar. | ||
| * Select **Sign in to use Copilot** from the Copilot menu in the Status Bar. | ||
|
|
||
|  | ||
|
|
||
| - Select the **Accounts** menu in the Activity Bar, and then select **Sign in with GitHub to use GitHub Copilot**. | ||
| * Select the **Accounts** menu in the Activity Bar, and then select **Sign in with GitHub to use GitHub Copilot**. | ||
|
|
||
|  | ||
|
|
||
| - Run the **GitHub Copilot: Sign in** command in the Command Palette (`kb(workbench.action.showCommands)`). | ||
| * Run the **GitHub Copilot: Sign in** command in the Command Palette (`kb(workbench.action.showCommands)`). | ||
|
|
||
| ## Use a different GitHub account per workspace or profile | ||
|
|
||
| You can use different GitHub accounts for Copilot per VS Code workspace or profile. This is useful if you use Copilot with different accounts for work and personal projects, or if you want to use different accounts for different extensions that use GitHub authentication. | ||
|
|
||
| Follow these steps to configure which GitHub account to use for Copilot. This configuration is saved per workspace and per profile. | ||
|
|
||
| * For GitHub.com accounts: | ||
|
|
||
| 1. In the Accounts menu in the Activity Bar, select **Manage Extension Account Preferences** | ||
| 1. Select **GitHub Copilot Chat** from the list of extensions | ||
| 1. Choose the GitHub account you want to use for Copilot in the current workspace and profile | ||
|
|
||
| * For GHE.com accounts: | ||
|
|
||
| > [!TIP] | ||
| > If you only want to use a GHE account for Copilot, follow the steps in [Use Copilot with a GHE account](#use-copilot-with-a-ghe-account) to sign in with your GHE account. | ||
|
|
||
| 1. Run **Preferences: Open User Settings (JSON)** or **Preferences: Open Workspace Settings (JSON)** from the Command Palette (`kb(workbench.action.showCommands)`) | ||
|
|
||
| 1. Add the following setting to specify GitHub Enterprise as the authentication provider for Copilot: | ||
|
|
||
| ```json | ||
| "github.copilot.advanced": { | ||
| "authProvider": "github-enterprise" | ||
| } | ||
| ``` | ||
|
|
||
| 1. Re-sign in to your GitHub Enterprise account if you're not already signed in | ||
| 1. Select **GitHub Copilot Chat** from the list of extensions | ||
| 1. Choose the GitHub Enterprise account you want to use for Copilot in the current workspace and profile | ||
|
||
|
|
||
| ## Remove AI features from VS Code | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is exactly what we wanna call out here.
One thing I notice is that this is the first and only reference to signing in to GHE.com in this doc which makes me worried that for folks who want to sign in with their GHE.com account will set this instead of going through the normal flow (Continue with GHE.com)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for pointing that out. I'll make sure to clarify this more.