Add XCode to Copilot Quickstart article (#57809)
This commit is contained in:
BIN
assets/images/help/copilot/xcode-chat-about-file.png
Normal file
BIN
assets/images/help/copilot/xcode-chat-about-file.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 33 KiB |
@@ -24,11 +24,15 @@ contentType: get-started
|
||||
|
||||
## Introduction
|
||||
|
||||
<!-- --------------------- -->
|
||||
<!-- Web browser -->
|
||||
<!-- --------------------- -->
|
||||
|
||||
{% webui %}
|
||||
|
||||
You can use {% data variables.product.prodname_copilot_short %} to get answers to coding-related questions, such as how best to code something, how to fix a bug, or how someone else's code works. For full details of what {% data variables.product.prodname_copilot_short %} can do, see [AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot).
|
||||
|
||||
Instructions for using {% data variables.product.prodname_copilot_short %} differ depending on where you are using it. This version of the quickstart is for {% data variables.product.github %}. Click the tabs above for instructions on using {% data variables.product.prodname_copilot_short %} in other environments.
|
||||
Instructions for using {% data variables.product.prodname_copilot_short %} differ depending on where you are using it. This version of the quickstart is for using {% data variables.product.prodname_copilot_short %} on the {% data variables.product.github %} website. Click the tabs above for instructions on using {% data variables.product.prodname_copilot_short %} in other environments.
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% data reusables.copilot.quickstart-signup %}
|
||||
@@ -82,6 +86,10 @@ For more information, see [AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-
|
||||
|
||||
{% endwebui %}
|
||||
|
||||
<!-- --------------------- -->
|
||||
<!-- Windows terminal -->
|
||||
<!-- --------------------- -->
|
||||
|
||||
{% windowsterminal %}
|
||||
|
||||
{% data reusables.copilot.quickstart-intro %}
|
||||
@@ -94,9 +102,7 @@ Instructions for using {% data variables.product.prodname_copilot_short %} diffe
|
||||
|
||||
## Prerequisites
|
||||
|
||||
{% ifversion ghec %}
|
||||
* **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_windows_terminal %}, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %}
|
||||
{% endif %}
|
||||
* **{% data variables.product.prodname_windows_terminal %} Canary**. Terminal Chat is only available in [{% data variables.product.prodname_windows_terminal %} Canary](https://github.com/microsoft/terminal?tab=readme-ov-file#installing-windows-terminal-canary).
|
||||
|
||||
## Use {% data variables.product.prodname_copilot_short %} in Terminal Chat
|
||||
@@ -132,6 +138,10 @@ After you've installed {% data variables.product.prodname_windows_terminal %} Ca
|
||||
|
||||
{% endwindowsterminal %}
|
||||
|
||||
<!-- --------------------- -->
|
||||
<!-- VS Code -->
|
||||
<!-- --------------------- -->
|
||||
|
||||
{% vscode %}
|
||||
|
||||
{% data reusables.copilot.quickstart-intro %}
|
||||
@@ -144,9 +154,7 @@ Instructions for using {% data variables.product.prodname_copilot_short %} diffe
|
||||
|
||||
## Prerequisites
|
||||
|
||||
{% ifversion ghec %}
|
||||
* **{% data variables.product.prodname_copilot_short %} subscription** - To use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode_shortname %}, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %}
|
||||
{% endif %}
|
||||
{% data reusables.copilot.vscode-prerequisites %}
|
||||
|
||||
## Chat with {% data variables.product.prodname_copilot %}
|
||||
@@ -190,6 +198,10 @@ The following example uses JavaScript, however other languages will work similar
|
||||
|
||||
{% endvscode %}
|
||||
|
||||
<!-- --------------------- -->
|
||||
<!-- Visual Studio -->
|
||||
<!-- --------------------- -->
|
||||
|
||||
{% visualstudio %}
|
||||
|
||||
{% data reusables.copilot.quickstart-intro %}
|
||||
@@ -202,9 +214,7 @@ Instructions for using {% data variables.product.prodname_copilot_short %} diffe
|
||||
|
||||
## Prerequisites
|
||||
|
||||
{% ifversion ghec %}
|
||||
* **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vs %}, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %}
|
||||
{% endif %}
|
||||
{% data reusables.copilot.visual-studio-prerequisites %}
|
||||
|
||||
## Chat with {% data variables.product.prodname_copilot %}
|
||||
@@ -240,6 +250,10 @@ The following example uses JavaScript, however other languages will work similar
|
||||
|
||||
{% endvisualstudio %}
|
||||
|
||||
<!-- --------------------- -->
|
||||
<!-- JetBrains -->
|
||||
<!-- --------------------- -->
|
||||
|
||||
{% jetbrains %}
|
||||
|
||||
{% data reusables.copilot.quickstart-intro %}
|
||||
@@ -252,9 +266,7 @@ Instructions for using {% data variables.product.prodname_copilot_short %} diffe
|
||||
|
||||
## Prerequisites
|
||||
|
||||
{% ifversion ghec %}
|
||||
* **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vs %}, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %}
|
||||
{% endif %}
|
||||
* **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in a JetBrains IDE, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %}
|
||||
* **A compatible JetBrains IDE**. {% data variables.product.prodname_copilot_short %} is supported in a large number of JetBrains IDEs. For a full list, see [AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide?tool=jetbrains).
|
||||
{% data reusables.copilot.jetbrains-plugin-prerequisites %}
|
||||
|
||||
@@ -291,3 +303,69 @@ The following example uses JavaScript, however other languages will work similar
|
||||
{% data reusables.copilot.quickstart-nextsteps2 %}
|
||||
|
||||
{% endjetbrains %}
|
||||
|
||||
<!-- --------------------- -->
|
||||
<!-- XCode -->
|
||||
<!-- --------------------- -->
|
||||
|
||||
{% xcode %}
|
||||
|
||||
{% data reusables.copilot.quickstart-intro %}
|
||||
|
||||
Instructions for using {% data variables.product.prodname_copilot_short %} differ depending on where you are using it. This version of the quickstart is for XCode in MacOS. Click the tabs above for instructions on using {% data variables.product.prodname_copilot_short %} in other environments.
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% data reusables.copilot.quickstart-signup %}
|
||||
{% endif %}
|
||||
|
||||
## Prerequisites
|
||||
|
||||
* **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in Xcode, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %}
|
||||
* **Latest version of the {% data variables.product.prodname_copilot %} extension**. For installation instructions, see [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-extension?tool=xcode).
|
||||
* **Sign in to {% data variables.product.company_short %} in Xcode**. If you experience authentication issues, see [AUTOTITLE](/copilot/troubleshooting-github-copilot/troubleshooting-issues-with-github-copilot-chat#troubleshooting-authentication-issues-in-your-editor).
|
||||
|
||||
## Chat with {% data variables.product.prodname_copilot %}
|
||||
|
||||
After you've installed the {% data variables.product.prodname_copilot %} plugin, you can ask {% data variables.product.prodname_copilot_short %} coding-related questions.
|
||||
|
||||
> [!NOTE] {% data reusables.copilot.chat-access-denied %}
|
||||
|
||||
1. Open an existing code file.
|
||||
1. Click **Editor** in the menu bar, then click **{% data variables.product.prodname_copilot %}** then **Open Chat**.
|
||||
|
||||
{% data variables.copilot.copilot_chat_short %} opens in a new window.
|
||||
|
||||
1. In the {% data variables.copilot.copilot_chat_short %} window, select the file to indicate that you want to chat about this file.
|
||||
|
||||

|
||||
|
||||
1. Type `what does this file do` then press <kbd>Enter</kbd>.
|
||||
|
||||
{% data variables.product.prodname_copilot_short %}'s answer is displayed below your question.
|
||||
|
||||
1. Select a line of code in the editor.
|
||||
1. In the {% data variables.copilot.copilot_chat_short %} window, type `explain this line` then press <kbd>Enter</kbd>.
|
||||
|
||||
## Get your first code completion suggestion
|
||||
|
||||
The following example uses Swift, however other languages will work similarly.
|
||||
|
||||
1. Create a new file called `CalculateDays.swift`.
|
||||
1. Type the following code in the new file:
|
||||
|
||||
```swift copy
|
||||
import Foundation
|
||||
|
||||
func calculateDaysBetweenDates(_ start: Date, _ end: Date)
|
||||
```
|
||||
|
||||
{% data variables.product.prodname_copilot %} adds a suggestion of code that continues this function. Suggestions are displayed in grayed text.
|
||||
1. {% data reusables.copilot.accept-suggestion %}
|
||||
1. {% data variables.product.prodname_copilot_short %} will continue to make suggestions, each of which you can accept by pressing <kbd>Tab</kbd>.
|
||||
|
||||
## Next steps
|
||||
|
||||
{% data reusables.copilot.quickstart-nextsteps1 %}
|
||||
{% data reusables.copilot.quickstart-nextsteps2 %}
|
||||
|
||||
{% endxcode %}
|
||||
|
||||
@@ -203,6 +203,7 @@ To use {% data variables.product.prodname_copilot %} for Xcode you must have Xco
|
||||
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 Xcode installed. To use {% data variables.product.prodname_copilot %} for Xcode you must have Xcode version 8.0 or above and macOS Monterey (12.0) or above. See [Xcode](https://developer.apple.com/xcode/) on the Apple Developer site.
|
||||
1. Download the latest version of the {% data variables.product.prodname_copilot %} for Xcode extension from the [`github/CopilotForXcode` repository](https://github.com/github/CopilotForXcode/releases/latest/download/GitHubCopilotForXcode.dmg) and install it. A background item will be added for the application to be able to start itself when Xcode starts.
|
||||
1. Open the **{% data variables.product.prodname_copilot %} for Xcode** application from the Applications folder and step through the on-screen instructions for setting up the extension.
|
||||
|
||||
## Granting required permissions
|
||||
|
||||
|
||||
Reference in New Issue
Block a user