Create Copilot Getting started category (#56309)
Co-authored-by: Sarah Schneider <sarahs@github.com> Co-authored-by: Evan Bonsignori <ebonsignori@github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>
This commit is contained in:
Siara
@@ -0,0 +1,87 @@
|
||||
---
|
||||
title: Best practices for using GitHub Copilot
|
||||
intro: 'Learn how to get the most out of {% data variables.product.prodname_copilot_short %}.'
|
||||
topics:
|
||||
- Copilot
|
||||
versions:
|
||||
feature: copilot
|
||||
shortTitle: Best practices
|
||||
redirect_from:
|
||||
- /copilot/using-github-copilot/best-practices-for-using-github-copilot
|
||||
---
|
||||
|
||||
## Understand {% data variables.product.prodname_copilot_short %}'s strengths and weaknesses
|
||||
|
||||
{% data variables.product.prodname_copilot %} is an AI coding assistant that helps you write code faster and with less effort, allowing you to focus more energy on problem solving and collaboration. Before you start working with {% data variables.product.prodname_copilot_short %}, it's important to understand when you should and shouldn't use it.
|
||||
|
||||
**Some of the things {% data variables.product.prodname_copilot_short %} does best include:**
|
||||
|
||||
* Writing tests and repetitive code
|
||||
* Debugging and correcting syntax
|
||||
* Explaining and commenting code
|
||||
* Generating regular expressions
|
||||
|
||||
**{% data variables.product.prodname_copilot_short %} is not designed to:**
|
||||
|
||||
* Respond to prompts unrelated to coding and technology
|
||||
* Replace your expertise and skills. Remember that you are in charge, and {% data variables.product.prodname_copilot_short %} is a powerful tool at your service.
|
||||
|
||||
## Choose the right {% data variables.product.prodname_copilot_short %} tool for the job
|
||||
|
||||
While {% data variables.product.prodname_copilot_short %} code completion and {% data variables.copilot.copilot_chat_short %} share some functionality, the two tools are best used in different circumstances.
|
||||
|
||||
**Code completion works best for:**
|
||||
|
||||
* Completing code snippets, variable names, and functions as you write them
|
||||
* Generating repetitive code
|
||||
* Generating code from inline comments in natural language
|
||||
* Generating tests for test-driven development
|
||||
|
||||
**Alternatively, {% data variables.copilot.copilot_chat_short %} is best suited for:**
|
||||
|
||||
* Answering questions about code in natural language
|
||||
* Generating large sections of code, then iterating on that code to meet your needs
|
||||
* Accomplishing specific tasks with keywords and skills. {% data variables.copilot.copilot_chat_short %} has built-in keywords and skills designed to provide important context for prompts and accomplish common tasks quickly. Different types of keywords and skills are available in different {% data variables.copilot.copilot_chat_short %} platforms. See [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide#using-keywords-in-your-prompt){% ifversion fpt %}.{% else %} and [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom#powered-by-skills).{% endif %}
|
||||
* Completing a task as a specific persona. For example, you can tell {% data variables.copilot.copilot_chat_short %} that it is a Senior C++ Developer who cares greatly about code quality, readability, and efficiency, then ask it to review your code.
|
||||
|
||||
## Create thoughtful prompts
|
||||
|
||||
Prompt engineering, or structuring your request so {% data variables.product.prodname_copilot_short %} can easily understand and respond to it, plays a critical role in {% data variables.product.prodname_copilot_short %}'s ability to generate a valuable response. Here are a few quick tips you should remember while crafting your prompts:
|
||||
|
||||
* Break down complex tasks.
|
||||
* Be specific about your requirements.
|
||||
* Provide examples of things like input data, outputs, and implementations.
|
||||
* Follow good coding practices.
|
||||
|
||||
To learn more, see [AUTOTITLE](/copilot/using-github-copilot/copilot-chat/prompt-engineering-for-copilot-chat).
|
||||
|
||||
## Check {% data variables.product.prodname_copilot_short %}'s work
|
||||
|
||||
While {% data variables.product.prodname_copilot_short %} is very powerful, it is still a tool capable of making mistakes, and you should always validate the code it suggests. Use the following tips to ensure you are accepting accurate, secure suggestions:
|
||||
|
||||
* **Understand suggested code before you implement it.** To ensure you fully understand {% data variables.product.prodname_copilot_short %}'s suggestion, you can ask {% data variables.copilot.copilot_chat_short %} to explain the code.
|
||||
* **Review {% data variables.product.prodname_copilot_short %}'s suggestions carefully.** Consider not just the functionality and security of the suggested code, but also the readability and maintainability of the code moving forward.
|
||||
* **Use automated tests and tooling to check {% data variables.product.prodname_copilot_short %}'s work.** With the help of tools like linting, {% data variables.product.prodname_code_scanning %}, and IP scanning, you can automate an additional layer of security and accuracy checks.
|
||||
|
||||
> [!TIP] Optionally, you may want to check {% data variables.product.prodname_copilot_short %}'s work for similarities to existing public code. If you don't want to use similar code, you can turn off suggestions matching public code. See {% ifversion fpt %}[AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-policies-as-an-individual-subscriber#enabling-or-disabling-suggestions-matching-public-code) or [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).{% else %}[AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-policies-as-an-individual-subscriber#enabling-or-disabling-suggestions-matching-public-code), [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching), or [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise#suggestions-matching-public-code).{% endif %}
|
||||
|
||||
## Guide {% data variables.product.prodname_copilot_short %} towards helpful outputs
|
||||
|
||||
There are several adjustments you can make to steer {% data variables.product.prodname_copilot_short %} towards more valuable responses:
|
||||
|
||||
* **Provide {% data variables.product.prodname_copilot_short %} with helpful context:**
|
||||
* If you are using {% data variables.product.prodname_copilot_short %} in your IDE, open relevant files and close irrelevant files.
|
||||
* In {% data variables.copilot.copilot_chat_short %}, if a particular request is no longer helpful context, delete that request from the conversation. Alternatively, if none of the context of a particular conversation is helpful, start a new conversation.
|
||||
* If you are using {% data variables.copilot.copilot_chat_dotcom_short %}, provide specific repositories, files, symbols, and more as context. See [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom).
|
||||
* If you are using {% data variables.copilot.copilot_chat_short %} in your IDE, use keywords to focus {% data variables.product.prodname_copilot_short %} on a specific task or piece of context. See [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide#using-keywords-in-your-prompt).
|
||||
* **Rewrite your prompts to generate different responses.** If {% data variables.product.prodname_copilot_short %} is not providing a helpful response, try rephrasing your prompt, or even breaking your request down into multiple smaller prompts.
|
||||
* **Pick the best available suggestion.** When you are using code completion, {% data variables.product.prodname_copilot_short %} might offer more than one suggestion. You can use keyboard shortcuts to quickly look through all available suggestions. For the default keyboard shortcuts for your operating system, see [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-your-environment#keyboard-shortcuts-for-github-copilot).
|
||||
* **Provide feedback to improve future suggestions.** You can provide feedback in many ways:
|
||||
* For code completion, accept or reject {% data variables.product.prodname_copilot_short %}'s suggestion.
|
||||
* For individual responses in {% data variables.copilot.copilot_chat_short %}, click the thumbs up or thumbs down icons next to the response.
|
||||
* For {% data variables.copilot.copilot_chat_short %} in your IDE, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide#sharing-feedback) for instructions specific to your environment.
|
||||
* For {% data variables.copilot.copilot_chat_dotcom_short %}, leave a comment on the [feedback discussion](https://github.com/orgs/community/discussions/110314).
|
||||
|
||||
## Stay up-to-date on {% data variables.product.prodname_copilot_short %}'s features
|
||||
|
||||
New features are regularly added to {% data variables.product.prodname_copilot_short %} to create new abilities, build on existing features, and improve the user experience. To stay up-to-date with {% data variables.product.prodname_copilot_short %}'s features, see the [changelog](https://github.blog/changelog/label/copilot/).
|
||||
@@ -0,0 +1,399 @@
|
||||
---
|
||||
title: Getting started with prompts for Copilot Chat
|
||||
intro: 'Get an overview of ways to use {% data variables.copilot.copilot_chat_short %}.'
|
||||
topics:
|
||||
- Copilot
|
||||
defaultTool: vscode
|
||||
versions:
|
||||
feature: copilot
|
||||
redirect_from:
|
||||
- /copilot/using-github-copilot/example-use-cases/example-prompts-for-copilot-chat
|
||||
- /copilot/using-github-copilot/guides-on-using-github-copilot/getting-started-with-prompts-for-copilot-chat
|
||||
- /copilot/using-github-copilot/copilot-chat/getting-started-with-prompts-for-copilot-chat
|
||||
shortTitle: Get started with chat
|
||||
---
|
||||
|
||||
You can ask {% data variables.copilot.copilot_chat_short %} specific questions about your project or general software questions. You can also ask {% data variables.copilot.copilot_chat_short %} to write code, fix errors, write tests, and document code.
|
||||
|
||||
Use the tabs above to select the environment where you are using {% data variables.copilot.copilot_chat_short %}.
|
||||
|
||||
{% vscode %}
|
||||
|
||||
Some of the following example prompts use chat participants (preceded by `@`), slash commands (preceded by `/`), or chat variables (preceded by `#`). For more information on keywords in prompts, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide#using-keywords-in-your-prompt).
|
||||
|
||||
## Ask general software questions
|
||||
|
||||
You can ask {% data variables.copilot.copilot_chat_short %} general software questions. For example:
|
||||
|
||||
* `tell me about nodejs web server frameworks`
|
||||
* `how can I create an Express app`
|
||||
* `@terminal how to update an npm package`
|
||||
|
||||
## Ask questions about your project
|
||||
|
||||
You can ask {% data variables.copilot.copilot_chat_short %} questions about your project.
|
||||
|
||||
* `what sorting algorithm does this function use`
|
||||
* `@workspace how are notifications scheduled`
|
||||
* `#file:gameReducer.js #file:gameInit.js how are these files related`
|
||||
|
||||
To give {% data variables.product.prodname_copilot_short %} the correct context, try some of these strategies:
|
||||
|
||||
* Highlight relevant lines of code.
|
||||
* Use chat variables like `#selection`, `#file`, `#editor`, `#codebase`, or `#git`.
|
||||
* Use the `@workspace` chat participant.
|
||||
|
||||
## Write code
|
||||
|
||||
You can ask {% data variables.product.prodname_copilot_short %} to write code for you. For example:
|
||||
|
||||
* `write a function to sum all numbers in a list`
|
||||
* `add error handling to this function`
|
||||
* `@workspace add form validation, similar to the newsletter page`
|
||||
|
||||
When {% data variables.product.prodname_copilot_short %} returns a code block, the response includes options to copy the code, or to insert the code at your cursor, into a new file, or into the terminal.
|
||||
|
||||
## Ask questions about alerts from {% data variables.product.prodname_GHAS %} features
|
||||
|
||||
You can ask {% data variables.product.prodname_copilot_short %} about security alerts in repositories in your organization from {% data variables.product.prodname_GHAS %} features ({% data variables.product.prodname_code_scanning %}, {% data variables.product.prodname_secret_scanning %}, and {% data variables.product.prodname_dependabot_alerts %}). For example:
|
||||
|
||||
* `How would I fix this alert?`
|
||||
* `How many alerts do I have on this pull request?`
|
||||
* `Which line of code is this {% data variables.product.prodname_code_scanning %} alert referencing?`
|
||||
* `What library is affected by this {% data variables.product.prodname_dependabot %} alert?`
|
||||
|
||||
## Set up a new project
|
||||
|
||||
Use the `/new` slash command to set up a new project. For example:
|
||||
|
||||
* `/new react app with typescript`
|
||||
* `/new python django web application`
|
||||
* `/new node.js express server`
|
||||
|
||||
Copilot will suggest a directory structure and provide a button to create the suggested files and contents. To preview a suggested file, select the file name in the suggested directory structure.
|
||||
|
||||
Use the `/newNotebook` slash command to set up a new Jupyter notebook. For example:
|
||||
|
||||
* `/newNotebook retrieve the titanic dataset and use Seaborn to plot the data`
|
||||
|
||||
## Fix, improve, and refactor code
|
||||
|
||||
If your active file contains an error, use the `/fix` slash command to ask {% data variables.product.prodname_copilot_short %} to fix the error.
|
||||
|
||||
You can also make general requests to improve or refactor your code.
|
||||
|
||||
* `how would you improve this code?`
|
||||
* `translate this code to C#`
|
||||
* `add error handling to this function`
|
||||
|
||||
## Write tests
|
||||
|
||||
Use the `/tests` slash command to ask {% data variables.product.prodname_copilot_short %} to write tests for the active file or selected code. For example:
|
||||
|
||||
* `/tests`
|
||||
* `/tests using the Jest framework`
|
||||
* `/tests ensure the function rejects an empty list`
|
||||
|
||||
The `/tests` slash command writes tests for existing code. If you prefer to write tests before writing code (test driven development), omit the `/tests` command. For example:
|
||||
|
||||
* `Add tests for a JavaScript function that should sum a list of integers`
|
||||
|
||||
## Ask questions about {% data variables.product.prodname_vscode %}
|
||||
|
||||
Use the `@vscode` chat participant to ask specific questions about {% data variables.product.prodname_vscode %}. For example:
|
||||
|
||||
* `@vscode tell me how to debug a node.js app`
|
||||
* `@vscode how do I change my {% data variables.product.prodname_vscode %} colors`
|
||||
* `@vscode how can I change key bindings`
|
||||
|
||||
## Ask questions about the command line
|
||||
|
||||
Use the `@terminal` chat participant to ask specific questions about the command line. For example:
|
||||
|
||||
* `@terminal find the largest file in the src directory`
|
||||
* `@terminal #terminalLastCommand` to explain the last command and any errors
|
||||
|
||||
{% endvscode %}
|
||||
|
||||
{% visualstudio %}
|
||||
|
||||
## Ask general software questions
|
||||
|
||||
You can ask {% data variables.copilot.copilot_chat_short %} general software questions. For example:
|
||||
|
||||
* `tell me about nodejs web server frameworks`
|
||||
* `how can I create an Express app`
|
||||
* `what's the process for updating an npm package`
|
||||
|
||||
## Ask questions about your project
|
||||
|
||||
You can ask {% data variables.copilot.copilot_chat_short %} questions about your project. To give {% data variables.product.prodname_copilot_short %} the correct context, try some of these strategies:
|
||||
|
||||
* Highlight relevant lines of code.
|
||||
* Open the relevant file.
|
||||
* Use `#file` to tell {% data variables.product.prodname_copilot_short %} to reference specific files.
|
||||
* Use `#solution` to tell {% data variables.product.prodname_copilot_short %} to reference the active file.
|
||||
|
||||
For example:
|
||||
|
||||
* `what sorting algorithm does this function use`
|
||||
* `#file:gameReducer.js what happens when a new game is requested`
|
||||
|
||||
## Write code
|
||||
|
||||
You can ask {% data variables.product.prodname_copilot_short %} to write code for you. For example:
|
||||
|
||||
* `write a function to sum all numbers in a list`
|
||||
* `add error handling to this function`
|
||||
|
||||
When {% data variables.product.prodname_copilot_short %} returns a code block, the response includes options to copy the code, insert the code into a new file, or preview the code output.
|
||||
|
||||
## Ask questions about alerts from {% data variables.product.prodname_GHAS %} features
|
||||
|
||||
You can ask {% data variables.product.prodname_copilot_short %} about security alerts in repositories in your organization from {% data variables.product.prodname_GHAS %} features ({% data variables.product.prodname_code_scanning %}, {% data variables.product.prodname_secret_scanning %}, and {% data variables.product.prodname_dependabot_alerts %}). For example:
|
||||
|
||||
* `How would I fix this alert?`
|
||||
* `How many alerts do I have on this pull request?`
|
||||
* `Which line of code is this {% data variables.product.prodname_code_scanning %} alert referencing?`
|
||||
* `What library is affected by this {% data variables.product.prodname_dependabot %} alert?`
|
||||
|
||||
## Fix, improve, and refactor code
|
||||
|
||||
If your active file contains an error, use the `/fix` slash command to ask {% data variables.product.prodname_copilot_short %} to fix the error.
|
||||
|
||||
You can also make general requests to improve or refactor your code.
|
||||
|
||||
* `how would you improve this code?`
|
||||
* `translate this code to C#`
|
||||
* `add error handling to this function`
|
||||
|
||||
## Write tests
|
||||
|
||||
Use the `/tests` slash command to ask {% data variables.product.prodname_copilot_short %} to write tests for the active file or selected code. For example:
|
||||
|
||||
* `/tests`
|
||||
* `/tests using the Jest framework`
|
||||
* `/tests ensure the function rejects an empty list`
|
||||
|
||||
The `/tests` slash command writes tests for existing code. If you prefer to write tests before writing code (test driven development), omit the `/tests` command. For example:
|
||||
|
||||
* `Add tests for a JavaScript function that should sum a list of integers`
|
||||
|
||||
{% endvisualstudio %}
|
||||
|
||||
{% jetbrains %}
|
||||
|
||||
## Ask general software questions
|
||||
|
||||
You can ask {% data variables.copilot.copilot_chat_short %} general software questions. For example:
|
||||
|
||||
* `tell me about nodejs web server frameworks`
|
||||
* `how can I create an Express app`
|
||||
* `what's the process for updating an npm package`
|
||||
|
||||
## Ask questions about your project
|
||||
|
||||
You can ask {% data variables.copilot.copilot_chat_short %} questions about your project. To give {% data variables.product.prodname_copilot_short %} the correct context, try some of these strategies:
|
||||
|
||||
* Highlight relevant lines of code.
|
||||
* Open the relevant file.
|
||||
* Add the file as a reference. For information about how to use file references, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide?tool=jetbrains#file-references).
|
||||
* Use the `@project` chat participant.
|
||||
|
||||
For example:
|
||||
|
||||
* `what sorting algorithm does this function use`
|
||||
* `how are these files related` (with references to the files in question)
|
||||
* `@project how are notifications scheduled`
|
||||
|
||||
## Write code
|
||||
|
||||
You can ask {% data variables.product.prodname_copilot_short %} to write code for you. For example:
|
||||
|
||||
* `write a function to sum all numbers in a list`
|
||||
* `add error handling to this function`
|
||||
|
||||
When {% data variables.product.prodname_copilot_short %} returns a code block, the response includes options to copy the code or to insert the code at your cursor.
|
||||
|
||||
## Fix, improve, and refactor code
|
||||
|
||||
If your active file contains an error, use the `/fix` slash command to ask {% data variables.product.prodname_copilot_short %} to fix the error.
|
||||
|
||||
You can also make general requests to improve or refactor your code.
|
||||
|
||||
* `how would you improve this code?`
|
||||
* `translate this code to C#`
|
||||
* `add error handling to this function`
|
||||
|
||||
## Write tests
|
||||
|
||||
Use the `/tests` slash command to ask {% data variables.product.prodname_copilot_short %} to write tests for the active file or selected code. For example:
|
||||
|
||||
* `/tests`
|
||||
* `/tests using the Jest framework`
|
||||
* `/tests ensure the function rejects an empty list`
|
||||
|
||||
The `/tests` slash command writes tests for existing code. If you prefer to write tests before writing code (test driven development), omit the `/tests` command. For example:
|
||||
|
||||
* `Add tests for a JavaScript function that should sum a list of integers`
|
||||
|
||||
{% endjetbrains %}
|
||||
|
||||
{% webui %}
|
||||
|
||||
Some of the example prompts require you to be in a specific context on the {% data variables.product.github %} website. For more information on how to access those contexts, see [Asking {% data variables.copilot.copilot_chat_short %} questions in different contexts](/copilot/using-github-copilot/asking-github-copilot-questions-in-github#asking-copilot-chat-questions-in-different-contexts).
|
||||
|
||||
## Ask general software questions
|
||||
|
||||
You can ask {% data variables.copilot.copilot_chat_short %} general software questions. For example:
|
||||
|
||||
* `tell me about nodejs web server frameworks`
|
||||
* `how can I create an Express app`
|
||||
* `what is the best way to update an npm package`
|
||||
|
||||
## Ask questions about a repository
|
||||
|
||||
You can ask {% data variables.copilot.copilot_chat_short %} questions about a repository. For example:
|
||||
|
||||
* `what is the purpose of this repository?`
|
||||
* `When was the most recent release?`
|
||||
* `Where is rate limiting implemented in our API?`
|
||||
* `What was the last merged PR by USERNAME`
|
||||
|
||||
## Ask questions about a specific file or symbol
|
||||
|
||||
You can ask {% data variables.copilot.copilot_chat_short %} questions about a specific file or symbol. For example:
|
||||
|
||||
* `what sorting algorithm does this function use`
|
||||
* `how are these files related`
|
||||
* `what is the purpose of this function`
|
||||
|
||||
## Ask questions about a knowledge base
|
||||
|
||||
You can ask {% data variables.copilot.copilot_chat_short %} questions about a knowledge base. For example:
|
||||
|
||||
* `How do I deploy a new application?`
|
||||
* `What's the process for creating a new REST API?`
|
||||
* `What are our best practices for logging?`
|
||||
|
||||
## Ask questions about a specific piece of code
|
||||
|
||||
You can ask {% data variables.copilot.copilot_chat_short %} questions about a specific piece of code. You might ask a question about a whole file, or a specific line. For example:
|
||||
|
||||
If you are asking about a whole file, you could enter:
|
||||
|
||||
* `Explain this file.`
|
||||
* `How could I improve this code?`
|
||||
* `How can I test this script?`
|
||||
|
||||
If you are asking about specific lines, you could enter:
|
||||
* `Explain the function at the selected lines.`
|
||||
* `How could I improve this class?`
|
||||
* `Add error handling to this code.`
|
||||
* `Write a unit test for this method.`
|
||||
|
||||
## Ask questions about alerts from {% data variables.product.prodname_GHAS %} products
|
||||
|
||||
You can ask {% data variables.copilot.copilot_chat_short %} questions about security alerts in repositories in your organization from {% data variables.product.prodname_GHAS %} features ({% data variables.product.prodname_code_scanning %}, {% data variables.product.prodname_secret_scanning %}, and {% data variables.product.prodname_dependabot_alerts %}). For example:
|
||||
|
||||
* `How would I fix this alert?`
|
||||
* `How many alerts do I have on this pull request?`
|
||||
* `Which line of code is this {% data variables.product.prodname_code_scanning %} alert referencing?`
|
||||
* `What library is affected by this {% data variables.product.prodname_dependabot %} alert?`
|
||||
|
||||
## Ask {% data variables.copilot.copilot_chat_short %} questions in a pull request
|
||||
|
||||
You can ask {% data variables.copilot.copilot_chat_short %} questions in a pull request. Your question could relate to various elements of the pull request For example:
|
||||
|
||||
You might ask for a summary of the changes in the pull request:
|
||||
|
||||
* `Summarize this PR for me.`
|
||||
* `Summarize the comments in this PR.`
|
||||
* `Summarize the changes in this PR.`
|
||||
|
||||
You might ask about the changes in a specific file in the pull request:
|
||||
|
||||
* `What's the purpose of this file?`
|
||||
* `Why has this module been included?`
|
||||
|
||||
You might ask about the changes in a specific line in the pull request:
|
||||
|
||||
* `What is "actorData" in this line?`
|
||||
* `Explain this "do..end" block.`
|
||||
|
||||
You might ask why a workflow failed:
|
||||
|
||||
* `Tell me why this job failed`
|
||||
* `Suggest a fix for this error`
|
||||
|
||||
## Ask {% data variables.copilot.copilot_chat_short %} questions about a specific issue or discussion
|
||||
|
||||
You can ask {% data variables.copilot.copilot_chat_short %} questions about a specific issue or discussion. For example:
|
||||
|
||||
* `what is the purpose of this issue?`
|
||||
|
||||
## Ask {% data variables.copilot.copilot_chat_short %} questions about a specific commit
|
||||
|
||||
You can ask {% data variables.copilot.copilot_chat_short %} questions about a specific commit. For example:
|
||||
|
||||
* `what is the purpose of this commit?`
|
||||
* `what is the expected output of this commit?`
|
||||
* `what is the best way to test this commit?`
|
||||
|
||||
{% endwebui %}
|
||||
|
||||
{% eclipse %}
|
||||
|
||||
## Ask general software questions
|
||||
|
||||
You can ask {% data variables.copilot.copilot_chat_short %} general software questions. For example:
|
||||
|
||||
* `tell me about nodejs web server frameworks`
|
||||
* `how can I create an Express app`
|
||||
* `what's the process for updating an npm package`
|
||||
|
||||
## Ask questions about files your project
|
||||
|
||||
You can ask {% data variables.copilot.copilot_chat_short %} questions about the file that's currently displayed in the editor, or about files you have attached to your conversation in the {% data variables.copilot.copilot_chat_short %} panel. To give {% data variables.product.prodname_copilot_short %} the correct context:
|
||||
|
||||
* Open the relevant file in the editor.
|
||||
* Click the paperclip icon in the {% data variables.copilot.copilot_chat_short %} panel, then search for and select files you want to attach to the conversation.
|
||||
|
||||
For example:
|
||||
|
||||
* `how can I make this file run faster`
|
||||
* `how are these files related` (with two or more attached files)
|
||||
* `explain the getSearchReplaceRules function`
|
||||
|
||||
## Write code
|
||||
|
||||
You can ask {% data variables.product.prodname_copilot_short %} to write code for you. For example:
|
||||
|
||||
* `write a TypeScript function to sum all numbers in a list`
|
||||
* `using the comments in this file, create appropriate Node JavaScript`
|
||||
|
||||
When {% data variables.product.prodname_copilot_short %} returns a code block, the response includes options to copy the code.
|
||||
|
||||
## Fix, improve, and refactor code
|
||||
|
||||
If your active file contains an error, use the `/fix` slash command to ask {% data variables.product.prodname_copilot_short %} to fix the error.
|
||||
|
||||
You can also make general requests to improve or refactor your code.
|
||||
|
||||
* `how would you improve the code in this file`
|
||||
* `translate this code to C#`
|
||||
* `add error handling to the main function`
|
||||
|
||||
## Write tests
|
||||
|
||||
Use the `/tests` slash command to ask {% data variables.product.prodname_copilot_short %} to write tests for the active file or selected code. For example:
|
||||
|
||||
* `/tests`
|
||||
* `/tests using the Jest framework`
|
||||
* `/tests ensure the function rejects an empty list`
|
||||
|
||||
The `/tests` slash command writes tests for existing code. If you prefer to write tests before writing code (test driven development), omit the `/tests` command. For example:
|
||||
|
||||
* `Add tests for a JavaScript function that should sum a list of integers`
|
||||
|
||||
{% endeclipse %}
|
||||
103
content/copilot/get-started/github-copilot-features.md
Normal file
103
content/copilot/get-started/github-copilot-features.md
Normal file
@@ -0,0 +1,103 @@
|
||||
---
|
||||
title: GitHub Copilot features
|
||||
intro: '{% data variables.product.prodname_copilot %} offers a suite of features. {% data variables.product.prodname_copilot_short %} also offers a suite of features for administrators.'
|
||||
versions:
|
||||
feature: copilot
|
||||
topics:
|
||||
- Copilot
|
||||
shortTitle: Copilot features
|
||||
redirect_from:
|
||||
- /copilot/copilot-business/github-copilot-business-feature-set
|
||||
- /copilot/copilot-individual/github-copilot-individual-feature-set
|
||||
- /copilot/github-copilot-enterprise/github-copilot-enterprise-feature-set
|
||||
- /copilot/about-github-copilot/github-copilot-features
|
||||
---
|
||||
|
||||
## {% data variables.product.prodname_copilot %} features
|
||||
|
||||
### Code completion
|
||||
|
||||
Autocomplete-style suggestions from {% data variables.product.prodname_copilot_short %} in supported IDEs _({% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, JetBrains IDEs, Azure Data Studio, Xcode, Vim/Neovim, and Eclipse)_. See [AUTOTITLE](/copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot).
|
||||
|
||||
If you use {% data variables.product.prodname_vscode_shortname %}, you can also use {% data variables.copilot.next_edit_suggestions %}, which will predict the location of the next edit you are likely to make and suggest a completion for it.
|
||||
|
||||
### {% data variables.copilot.copilot_chat_short %}
|
||||
|
||||
A chat interface that lets you ask coding-related questions. {% data variables.copilot.copilot_chat %} is available on the {% data variables.product.github %} website, in {% data variables.product.prodname_mobile %}, in supported IDEs _({% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, JetBrains IDEs, Eclipse IDE, and Xcode)_, and in {% data variables.product.prodname_windows_terminal %}. Users can also use skills with {% data variables.copilot.copilot_chat_short %}. See [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-github) and [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide).
|
||||
|
||||
### {% data variables.copilot.copilot_coding_agent %} ({% data variables.release-phases.public_preview %})
|
||||
|
||||
An autonomous AI agent that can make code changes for you. You can assign a {% data variables.product.github %} issue to {% data variables.product.prodname_copilot_short %} and the agent will work on making the required changes, and will create a pull request for you to review. You can also ask {% data variables.product.prodname_copilot_short %} to create a pull request from {% data variables.copilot.copilot_chat_short %}. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent).
|
||||
|
||||
### {% data variables.copilot.copilot_cli_short %}
|
||||
|
||||
A chat-like interface in the terminal, where you can ask questions about the command line. You can ask {% data variables.product.prodname_copilot_short %} to provide command suggestions or explanations of commands. Users can also integrate {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_windows_terminal %} Canary. See [AUTOTITLE](/copilot/using-github-copilot/using-github-copilot-in-the-command-line).
|
||||
|
||||
### {% data variables.product.prodname_copilot %} code review
|
||||
|
||||
AI-generated code review suggestions to help you write better code. See [AUTOTITLE](/copilot/using-github-copilot/code-review/using-copilot-code-review).
|
||||
|
||||
### {% data variables.copilot.copilot_for_prs %}
|
||||
|
||||
AI-generated summaries of the changes that were made in a pull request, which files they impact, and what a reviewer should focus on when they conduct their review. See [AUTOTITLE](/copilot/using-github-copilot/creating-a-pull-request-summary-with-github-copilot).
|
||||
|
||||
### {% data variables.copilot.copilot_autocomplete_pr %} ({% data variables.release-phases.public_preview %})
|
||||
|
||||
AI-generated text completion to help you write pull request descriptions quickly and accurately. See [AUTOTITLE](/copilot/using-github-copilot/using-copilot-text-completion).
|
||||
|
||||
### {% data variables.copilot.copilot_extensions %}
|
||||
|
||||
{% data reusables.copilot.copilot-extensions.copilot-extensions-intro %} See [AUTOTITLE](/copilot/building-copilot-extensions/about-building-copilot-extensions).
|
||||
|
||||
### {% data variables.product.prodname_github_models %} ({% data variables.release-phases.public_preview %})
|
||||
|
||||
Bringing the power of industry leading large and small language models to users directly on {% data variables.product.github %}. See [AUTOTITLE](/github-models).
|
||||
|
||||
### {% data variables.copilot.copilot_edits_short %}
|
||||
|
||||
{% data variables.copilot.copilot_edits_short %} is available in {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, and JetBrains IDEs. {% data reusables.copilot.copilot-edits.about-copilot-edits %}
|
||||
|
||||
### {% data variables.product.prodname_copilot_short %} custom instructions
|
||||
|
||||
Enhance {% data variables.copilot.copilot_chat_short %} responses by providing contextual details on your preferences, tools, and requirements. See [AUTOTITLE](/copilot/customizing-copilot/about-customizing-github-copilot-chat-responses).
|
||||
|
||||
### {% data variables.copilot.copilot_desktop_short %} ({% data variables.release-phases.public_preview %})
|
||||
|
||||
Automatically generate commit messages and descriptions with {% data variables.copilot.copilot_desktop_short %} based on the changes you make to your project.
|
||||
|
||||
### {% data variables.copilot.copilot_spaces %} ({% data variables.release-phases.public_preview %})
|
||||
|
||||
Organize and centralize relevant content—like code, docs, specs, and more—into {% data variables.copilot.copilot_spaces_short %} that ground {% data variables.product.prodname_copilot_short %}’s responses in the right context for a specific task. See [AUTOTITLE](/copilot/using-github-copilot/copilot-spaces/about-organizing-and-sharing-context-with-copilot-spaces).
|
||||
|
||||
### {% data variables.product.prodname_copilot_short %} knowledge bases _({% data variables.copilot.copilot_enterprise_short %} only)_
|
||||
|
||||
Create and manage collections of documentation to use as context for chatting with {% data variables.product.prodname_copilot_short %}. When you ask a question in {% data variables.copilot.copilot_chat_dotcom_short %} or in {% data variables.product.prodname_vscode_shortname %}, you can specify a knowledge base as the context for your question. See [AUTOTITLE](/copilot/customizing-copilot/managing-copilot-knowledge-bases).
|
||||
|
||||
## {% data variables.product.prodname_copilot %} features for administrators
|
||||
|
||||
The following features are available to organization and enterprise owners with a {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} plan.
|
||||
|
||||
### Policy management
|
||||
|
||||
Manage policies for {% data variables.product.prodname_copilot_short %} in your organization or enterprise. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization) and [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise).
|
||||
|
||||
### Access management
|
||||
|
||||
Enterprise owners can specify which organizations in the enterprise can use {% data variables.product.prodname_copilot_short %}, and organization owners can specify which organization members can use Copilot. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization) and [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise).
|
||||
|
||||
### Usage data
|
||||
|
||||
Review {% data variables.product.prodname_copilot_short %} usage data within your organization or enterprise to inform how to manage access and drive adoption of {% data variables.product.prodname_copilot_short %}. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization) and [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/viewing-copilot-license-usage-in-your-enterprise).
|
||||
|
||||
### Audit logs
|
||||
|
||||
Review audit logs for {% data variables.product.prodname_copilot_short %} in your organization to understand what actions have been taken and by which users. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-audit-logs-for-copilot-business).
|
||||
|
||||
### Exclude files
|
||||
|
||||
Configure {% data variables.product.prodname_copilot_short %} to ignore certain files. This can be useful if you have files that you don't want to be available to {% data variables.product.prodname_copilot_short %}. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/excluding-content-from-github-copilot).
|
||||
|
||||
## Next steps
|
||||
|
||||
* To learn more about the plans available for {% data variables.product.prodname_copilot %}, see [AUTOTITLE](/copilot/about-github-copilot/subscription-plans-for-github-copilot).
|
||||
* To start using {% data variables.product.prodname_copilot_short %}, see [AUTOTITLE](/copilot/setting-up-github-copilot).
|
||||
20
content/copilot/get-started/index.md
Normal file
20
content/copilot/get-started/index.md
Normal file
@@ -0,0 +1,20 @@
|
||||
---
|
||||
title: 'Get started with {% data variables.product.prodname_copilot %}'
|
||||
shortTitle: Get started
|
||||
intro: 'Learn how to sign up for and use {% data variables.product.prodname_copilot %}.'
|
||||
versions:
|
||||
feature: copilot
|
||||
topics:
|
||||
- Copilot
|
||||
children:
|
||||
- /quickstart
|
||||
- /what-is-github-copilot
|
||||
- /plans-for-github-copilot
|
||||
- /github-copilot-features
|
||||
- /setting-up-github-copilot
|
||||
- /best-practices-for-using-github-copilot
|
||||
- /getting-started-with-prompts-for-copilot-chat
|
||||
redirect_from:
|
||||
- /copilot/about-github-copilot
|
||||
---
|
||||
|
||||
48
content/copilot/get-started/plans-for-github-copilot.md
Normal file
48
content/copilot/get-started/plans-for-github-copilot.md
Normal file
@@ -0,0 +1,48 @@
|
||||
---
|
||||
title: Plans for GitHub Copilot
|
||||
intro: 'Learn about the available plans for {% data variables.product.prodname_copilot_short %}.'
|
||||
versions:
|
||||
feature: copilot
|
||||
topics:
|
||||
- Copilot
|
||||
shortTitle: Plans for Copilot
|
||||
redirect_from:
|
||||
- /copilot/about-github-copilot/subscription-plans-for-github-copilot
|
||||
- /copilot/about-github-copilot/plans-for-github-copilot
|
||||
---
|
||||
|
||||
{% data variables.product.company_short %} offers several plans for {% data variables.product.prodname_copilot %}, depending on your needs and whether you're using {% data variables.product.prodname_copilot_short %} as an individual or as part of an organization or enterprise.
|
||||
|
||||
* **{% data variables.copilot.copilot_free %}** is available to individual developers who don't have access to {% data variables.product.prodname_copilot_short %} through an organization or enterprise. This free plan includes limited access to select {% data variables.product.prodname_copilot_short %} features, allowing you to try AI-powered coding assistance at no cost.
|
||||
|
||||
* **{% data variables.copilot.copilot_pro %}** is designed for individuals who want more flexibility. This paid plan includes unlimited completions, access to premium models in {% data variables.copilot.copilot_chat_short %}, access to {% data variables.copilot.copilot_coding_agent %}, and a monthly allowance of premium requests. Verified students, teachers, and maintainers of popular open source projects may be eligible for free access.
|
||||
|
||||
* **{% data variables.copilot.copilot_pro_plus %}** offers the highest level of access for individual developers. In addition to everything in {% data variables.copilot.copilot_pro_short %}, this plan includes a larger allowance of premium requests, and full access to all available models in {% data variables.copilot.copilot_chat_short %}. Ideal for AI power users who want access to the most advanced capabilities.
|
||||
|
||||
* **{% data variables.copilot.copilot_for_business %}** is for organizations on {% data variables.product.prodname_free_team %} or {% data variables.product.prodname_team %} plan, or enterprises on {% data variables.product.prodname_ghe_cloud %}. This plan includes {% data variables.copilot.copilot_coding_agent %} and enables centralized management and {% data variables.product.prodname_copilot_short %} policy control for organization members.
|
||||
|
||||
* **{% data variables.copilot.copilot_enterprise %}** is for enterprises using {% data variables.product.prodname_ghe_cloud %}. It includes all the features of {% data variables.copilot.copilot_business_short %}, plus additional enterprise-grade capabilities. Enterprise owners can assign either {% data variables.copilot.copilot_enterprise_short %} or {% data variables.copilot.copilot_business_short %} to individual organizations.
|
||||
|
||||
{% data variables.product.prodname_copilot_short %} is not currently available for {% data variables.product.prodname_ghe_server %}.
|
||||
|
||||
## Comparing {% data variables.product.prodname_copilot_short %} plans
|
||||
|
||||
The tables below show the features available in each {% data variables.product.prodname_copilot_short %} plan.
|
||||
|
||||
{% data reusables.copilot.differences-cfi-cfb-table %}
|
||||
|
||||
For more information, see [AUTOTITLE](/copilot/about-github-copilot/github-copilot-features).
|
||||
|
||||
## Ready to choose a plan?
|
||||
|
||||
Start using {% data variables.product.prodname_copilot_short %} by signing up for the plan that best fits your needs.
|
||||
|
||||
* **{% data variables.copilot.copilot_free_short %}** — Try {% data variables.product.prodname_copilot_short %} with limited features and requests. [Start using {% data variables.copilot.copilot_free_short %}](https://github.com/copilot).
|
||||
|
||||
* **{% data variables.copilot.copilot_pro_short %}** — Get unlimited completions and access to premium models. Includes a free 30-day trial for eligible users. [Try {% data variables.copilot.copilot_pro_short %} for free](https://github.com/github-copilot/signup?ref_cta=Copilot+trial&ref_loc=about+github+copilot&ref_page=docs).
|
||||
|
||||
* **{% data variables.copilot.copilot_pro_plus_short %}** — Unlock advanced AI models, extended request limits, and extra capabilities. [Subscribe to {% data variables.copilot.copilot_pro_plus_short %}](https://github.com/github-copilot/signup?ref_cta=Copilot+Pro%2B&ref_loc=subscriptions+page&ref_page=docs).
|
||||
|
||||
* **{% data variables.copilot.copilot_business_short %}** — For teams and organizations. [Subscribe to {% data variables.copilot.copilot_business_short %}](https://github.com/github-copilot/purchase?priority=business&cft=copilot_li.copilot_plans.cfb).
|
||||
|
||||
* **{% data variables.copilot.copilot_enterprise_short %}** — For enterprises that need advanced features and centralized management. [Subscribe to {% data variables.copilot.copilot_enterprise_short %}](https://github.com/github-copilot/purchase?priority=enterprise&cft=copilot_li.copilot_plans.ce).
|
||||
292
content/copilot/get-started/quickstart.md
Normal file
292
content/copilot/get-started/quickstart.md
Normal file
@@ -0,0 +1,292 @@
|
||||
---
|
||||
title: Quickstart for GitHub Copilot
|
||||
intro: 'Quickly learn how to use {% data variables.product.prodname_copilot %}.'
|
||||
allowTitleToDifferFromFilename: true
|
||||
versions:
|
||||
feature: copilot
|
||||
redirect_from:
|
||||
- /copilot/getting-started-with-github-copilot
|
||||
- /github/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio-code
|
||||
- /github/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-a-jetbrains-ide
|
||||
- /github/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-neovim
|
||||
- /github/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio
|
||||
- /copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio-code
|
||||
- /copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-a-jetbrains-ide
|
||||
- /copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-neovim
|
||||
- /copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio
|
||||
- /copilot/using-github-copilot/getting-started-with-github-copilot
|
||||
- /copilot/quickstart
|
||||
shortTitle: Quickstart
|
||||
topics:
|
||||
- Copilot
|
||||
---
|
||||
|
||||
## Introduction
|
||||
|
||||
{% 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.
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% data reusables.copilot.quickstart-signup %}
|
||||
{% endif %}
|
||||
|
||||
{% ifversion ghec %}
|
||||
|
||||
## Prerequisite
|
||||
|
||||
To use {% data variables.product.prodname_copilot_short %} on the {% data variables.product.github %} website, you must have an active {% data variables.product.prodname_copilot_short %} plan. {% data reusables.copilot.subscription-prerequisite %}
|
||||
{% endif %}
|
||||
|
||||
## Asking your first question
|
||||
|
||||
1. On {% data variables.product.github %}, navigate to a repository and open a file.
|
||||
1. Click the {% data variables.product.prodname_copilot_short %} icon ({% octicon "copilot" aria-hidden="true" aria-label="copilot" %}) at the top right of the file view.
|
||||
|
||||
|
||||
|
||||
1. Type a question in the "Ask {% data variables.product.prodname_copilot_short %}" box at the bottom of the chat panel and press <kbd>Enter</kbd>.
|
||||
|
||||
For example, you could enter:
|
||||
|
||||
* Explain this file.
|
||||
* How could I improve this code?
|
||||
* How can I test this code?
|
||||
|
||||
{% data variables.product.prodname_copilot_short %} responds to your request in the panel.
|
||||
|
||||
1. You can continue the conversation by asking a follow-up question. For example, you could type "tell me more" to get {% data variables.product.prodname_copilot_short %} to expand on its last comment.
|
||||
|
||||
## Other questions you can ask
|
||||
|
||||
There are many more things you can do with {% data variables.copilot.copilot_chat_dotcom %}. For example:
|
||||
|
||||
* Ask a general question about software development
|
||||
* Ask exploratory questions about a repository
|
||||
* Ask a question about a knowledge base
|
||||
* Find out about the changes in a pull request
|
||||
* Ask a question about a specific issue or commit
|
||||
|
||||
For more information, see [AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom).
|
||||
|
||||
## Next steps
|
||||
|
||||
* **Find out more about {% data variables.copilot.copilot_chat %}** - See [AUTOTITLE](/copilot/github-copilot-chat/using-github-copilot-chat-in-your-ide){% ifversion fpt %}.{% endif %}{% ifversion ghec %} and [AUTOTITLE](/copilot/github-copilot-enterprise/copilot-chat-in-github/using-github-copilot-chat-in-githubcom).{% endif %}
|
||||
* **Get {% data variables.product.prodname_copilot_short %} code completion suggestions in an IDE** - See [AUTOTITLE](/enterprise-cloud@latest/copilot/using-github-copilot/using-github-copilot-code-suggestions-in-your-editor).
|
||||
* **Learn how to write effective prompts** - See [AUTOTITLE](/copilot/using-github-copilot/prompt-engineering-for-github-copilot).
|
||||
* **Use {% data variables.product.prodname_copilot_short %} on your mobile device** - See [AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-github-mobile/using-github-copilot-chat-in-github-mobile).
|
||||
* **Use {% data variables.product.prodname_copilot_short %} on the command line** - See [AUTOTITLE](/copilot/github-copilot-in-the-cli/using-github-copilot-in-the-cli).
|
||||
|
||||
{% endwebui %}
|
||||
|
||||
{% windowsterminal %}
|
||||
|
||||
{% 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 {% data variables.product.prodname_windows_terminal %}. 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
|
||||
|
||||
{% 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
|
||||
|
||||
After you've installed {% data variables.product.prodname_windows_terminal %} Canary, you can use {% data variables.product.prodname_copilot_short %} in [Terminal Chat](https://learn.microsoft.com/windows/terminal/terminal-chat) to ask command line-related questions.
|
||||
|
||||
1. Open **Settings** from the dropdown menu.
|
||||
|
||||
|
||||
|
||||
1. Go to the **Terminal Chat (Experimental)** setting.
|
||||
|
||||
|
||||
|
||||
1. Under **Service Providers**, select **GitHub Copilot** and **Authenticate via GitHub** to sign in.
|
||||
|
||||
## Chat with {% data variables.product.prodname_copilot %}
|
||||
|
||||
> [!NOTE] {% data reusables.copilot.windows-terminal-access-denied %}
|
||||
|
||||
1. Open **Terminal Chat (Experimental)** in the dropdown menu.
|
||||
|
||||
1. In the Terminal Chat chat window, type `how do i list all markdown files in my directory` then press <kbd>Enter</kbd>.
|
||||
|
||||
{% data variables.product.prodname_copilot_short %}'s answer is displayed below your question.
|
||||
|
||||
1. Click on an answer to insert it to the command line.
|
||||
|
||||
## Next steps
|
||||
|
||||
{% data reusables.copilot.quickstart-nextsteps1 %}
|
||||
{% data reusables.copilot.quickstart-nextsteps2 %}
|
||||
|
||||
{% endwindowsterminal %}
|
||||
|
||||
{% vscode %}
|
||||
|
||||
{% 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 {% data variables.product.prodname_vscode %}. 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
|
||||
|
||||
{% 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 %}
|
||||
|
||||
After you've installed the {% data variables.product.prodname_copilot %} extension, 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. Open the Chat view from the Activity Bar.
|
||||
|
||||
|
||||
|
||||
1. At the bottom of the chat view, in the chat input field, type: `explain this file`.
|
||||
1. Press <kbd>Enter</kbd>.
|
||||
|
||||
{% data variables.product.prodname_copilot_short %} replies in the chat view.
|
||||
|
||||
1. In the editor, select one or more lines of code that are not commented.
|
||||
1. In the chat input field, type: `add comments to these lines`.
|
||||
1. If you like the comments that {% data variables.product.prodname_copilot_short %} suggests, hover over the suggested code in the chat view and click the "Insert at Cursor" icon to replace the selected lines with the suggested code.
|
||||
|
||||
|
||||
|
||||
## Get your first code completion suggestion
|
||||
|
||||
The following example uses JavaScript, however other languages will work similarly. {% data reusables.copilot.supported-languages %}
|
||||
|
||||
1. Open {% data variables.product.prodname_vscode %}.
|
||||
{% 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.
|
||||
1. {% data reusables.copilot.accept-suggestion %}
|
||||
|
||||
## Next steps
|
||||
|
||||
{% data reusables.copilot.quickstart-nextsteps1 %}
|
||||
* **Use {% data variables.product.prodname_copilot_short %} like a pro** - Learn how to write effective prompts for {% data variables.product.prodname_copilot %}. For more information, see [Best practices for using {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/docs/copilot/prompt-crafting) in the {% data variables.product.prodname_vscode %} documentation.
|
||||
* **Get familiar with {% data variables.copilot.next_edit_suggestions %}** - See [About {% data variables.copilot.next_edit_suggestions %}](/copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot#about-next-edit-suggestions).
|
||||
{% data reusables.copilot.quickstart-nextsteps2 %}
|
||||
|
||||
{% endvscode %}
|
||||
|
||||
{% visualstudio %}
|
||||
|
||||
{% 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 {% data variables.product.prodname_vs %}. 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
|
||||
|
||||
{% 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 %}
|
||||
|
||||
After you've installed the {% data variables.product.prodname_copilot %} extension, 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. In the {% data variables.product.prodname_vs %} menu bar, click **View**, then click **{% data variables.copilot.copilot_chat %}**.
|
||||
1. In the {% data variables.copilot.copilot_chat_short %} window, 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 JavaScript, however other languages will work similarly. {% data reusables.copilot.supported-languages %}
|
||||
|
||||
1. Open {% data variables.product.prodname_vs %}.
|
||||
1. In {% data variables.product.prodname_vs %}, create a new JavaScript (_*.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.
|
||||
1. {% data reusables.copilot.accept-suggestion %}
|
||||
|
||||
## Next steps
|
||||
|
||||
{% data reusables.copilot.quickstart-nextsteps1 %}
|
||||
* **Prompt like a pro** - Watch [{% data variables.product.prodname_vs %} Prompt Engineering with {% data variables.product.prodname_copilot %}](https://www.youtube.com/watch?v=9hZsOeIINg8&list=PLReL099Y5nRckZDdcQ21UigO9pKa14yxC) on YouTube.
|
||||
{% data reusables.copilot.quickstart-nextsteps2 %}
|
||||
|
||||
{% endvisualstudio %}
|
||||
|
||||
{% jetbrains %}
|
||||
|
||||
{% 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 JetBrains IDEs. 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
|
||||
|
||||
{% 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 %}
|
||||
* **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 %}
|
||||
|
||||
## 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. Open the {% data variables.copilot.copilot_chat_short %} window by clicking the **{% data variables.copilot.copilot_chat_short %}** icon at the right side of the JetBrains IDE window.
|
||||
|
||||
|
||||
|
||||
1. In the {% data variables.copilot.copilot_chat_short %} window, 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 JavaScript, however other languages will work similarly. {% data reusables.copilot.supported-languages %}
|
||||
|
||||
1. In your JetBrains editor, create a new JavaScript (_*.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.
|
||||
1. {% data reusables.copilot.accept-suggestion %}
|
||||
|
||||
## Next steps
|
||||
|
||||
{% data reusables.copilot.quickstart-nextsteps1 %}
|
||||
{% data reusables.copilot.quickstart-nextsteps2 %}
|
||||
|
||||
{% endjetbrains %}
|
||||
@@ -0,0 +1,16 @@
|
||||
---
|
||||
title: Setting up GitHub Copilot
|
||||
shortTitle: Set up
|
||||
intro: 'Learn how to set up {% data variables.product.prodname_copilot %}.'
|
||||
topics:
|
||||
- Copilot
|
||||
versions:
|
||||
feature: copilot
|
||||
children:
|
||||
- /setting-up-github-copilot-for-yourself
|
||||
- /setting-up-github-copilot-for-your-organization
|
||||
- /setting-up-github-copilot-for-your-enterprise
|
||||
redirect_from:
|
||||
- /copilot/setting-up-github-copilot
|
||||
---
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
title: Setting up GitHub Copilot for your enterprise
|
||||
shortTitle: Set up for enterprise
|
||||
intro: 'Follow these steps to set up {% data variables.product.prodname_copilot %} in your enterprise.'
|
||||
permissions: Enterprise owners
|
||||
product: 'Enterprises with a {% data variables.copilot.copilot_enterprise_short %} or {% data variables.copilot.copilot_business_short %} plan'
|
||||
versions:
|
||||
feature: copilot
|
||||
topics:
|
||||
- Copilot
|
||||
redirect_from:
|
||||
- /copilot/github-copilot-enterprise/enabling-github-copilot-enterprise-features
|
||||
- /copilot/github-copilot-enterprise/overview/enabling-github-copilot-enterprise
|
||||
- /copilot/github-copilot-enterprise/overview/enabling-github-copilot-enterprise-features
|
||||
- /copilot/setting-up-github-copilot/setting-up-github-copilot-for-your-enterprise
|
||||
---
|
||||
|
||||
## 1. Enable {% data variables.product.prodname_copilot %} in your Enterprise through payment verification
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.settings-tab %}
|
||||
1. Click the **{% octicon "check-circle" aria-hidden="true" aria-label="check-circle" %} Getting Started** tab.
|
||||
1. Under "Next steps", click **Verify your payment method**. This will enable {% data variables.product.prodname_copilot %} in your enterprise.
|
||||
|
||||
After you've completed these steps, you will be able to confirm that {% data variables.product.prodname_copilot %} is enabled in your enterprise's **{% octicon "law" aria-hidden="true" aria-label="law" %} Policies** tab.
|
||||
|
||||
## 2. Set policies
|
||||
|
||||
Control which {% data variables.product.prodname_copilot_short %} features are available in your enterprise. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise).
|
||||
|
||||
## 3. Set up networking (if necessary)
|
||||
|
||||
If your enterprise users connect through an HTTP proxy server or firewall, ensure that key URLs are added to the allowlist for the proxy server or firewall. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-your-proxy-server-or-firewall-for-copilot).
|
||||
|
||||
You may also need to install custom SSL certificates on your users' machines. See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-network-settings-for-github-copilot#installing-custom-certificates).
|
||||
|
||||
## 4. Grant access to organizations
|
||||
|
||||
Enable {% data variables.product.prodname_copilot_short %} for some or all organizations in your enterprise. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise). Each organization owner can then grant {% data variables.product.prodname_copilot_short %} access to some or all of the members of their organization.
|
||||
|
||||
If your enterprise is on {% data variables.enterprise.data_residency_site %}, users must perform some additional setup to authenticate to their account from their development environment. See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/using-github-copilot-with-an-account-on-ghecom).
|
||||
|
||||
## 5. Drive {% data variables.product.prodname_copilot_short %} adoption
|
||||
|
||||
Planning and implementing an effective enablement process is essential to drive adoption of {% data variables.product.prodname_copilot_short %} in your enterprise. See [AUTOTITLE](/copilot/rolling-out-github-copilot-at-scale/driving-copilot-adoption-in-your-company).
|
||||
@@ -0,0 +1,55 @@
|
||||
---
|
||||
title: Setting up GitHub Copilot for your organization
|
||||
shortTitle: Set up for organization
|
||||
intro: 'Follow these steps to set up {% data variables.product.prodname_copilot %} in your organization.'
|
||||
permissions: Organization owners
|
||||
product: 'Organizations with a {% data variables.copilot.copilot_enterprise_short %} or {% data variables.copilot.copilot_business_short %} plan'
|
||||
versions:
|
||||
feature: copilot
|
||||
topics:
|
||||
- Copilot
|
||||
redirect_from:
|
||||
- /copilot/copilot-business/enabling-and-setting-up-github-copilot-business
|
||||
- /copilot/overview-of-github-copilot/enabling-and-setting-up-github-copilot-for-business
|
||||
- /copilot/managing-copilot-business/enabling-and-setting-up-github-copilot-for-business
|
||||
- /copilot/managing-copilot-business/enabling-and-setting-up-github-copilot-business
|
||||
- /copilot/setting-up-github-copilot/setting-up-github-copilot-for-your-organization
|
||||
---
|
||||
|
||||
## 1. Subscribe your organization to {% data variables.product.prodname_copilot %}
|
||||
|
||||
Set up a {% data variables.copilot.copilot_business_short %} plan for your organization. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/subscribing-to-copilot-for-your-organization).
|
||||
|
||||
If your organization is part of an enterprise with a {% data variables.copilot.copilot_enterprise_short %} or {% data variables.copilot.copilot_business_short %} plan, your enterprise owner can instead enable {% data variables.product.prodname_copilot_short %} for your organization. You can request access from your enterprise owner by going to [https://github.com/settings/copilot](https://github.com/settings/copilot) and requesting access under "Get Copilot from an organization."
|
||||
|
||||
## 2. Set policies
|
||||
|
||||
Control which {% data variables.product.prodname_copilot_short %} features are available in your organization. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-github-copilot-features-in-your-organization/managing-policies-for-copilot-in-your-organization).
|
||||
|
||||
## 3. Set up networking (if necessary)
|
||||
|
||||
If your organization members connect through an HTTP proxy server or firewall, ensure that key URLs are added to the allowlist for the proxy server or firewall. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-your-proxy-server-or-firewall-for-copilot).
|
||||
|
||||
You may also need to install custom SSL certificates on your members' machines. See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-network-settings-for-github-copilot#-installing-custom-certificates).
|
||||
|
||||
## 4. Grant access to members
|
||||
|
||||
Enable {% data variables.product.prodname_copilot_short %} for some or all members of your organization. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization).
|
||||
|
||||
To help drive adoption of {% data variables.product.prodname_copilot_short %} in your organization, think about what teams or members are most excited about {% data variables.product.prodname_copilot_short %} or could benefit the most from {% data variables.product.prodname_copilot_short %}. You may want to enable {% data variables.product.prodname_copilot_short %} for those members before enabling {% data variables.product.prodname_copilot_short %} for your whole organization. This can help you discover blockers, demonstrate early success, and set your organization up for a successful {% data variables.product.prodname_copilot_short %} rollout.
|
||||
|
||||
{% data reusables.copilot.self-serve-license-link %}
|
||||
|
||||
If your organization is part of an enterprise on {% data variables.enterprise.data_residency_site %}, users must perform some additional setup to authenticate to their account from their development environment. See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/using-github-copilot-with-an-account-on-ghecom).
|
||||
|
||||
## 5. Drive {% data variables.product.prodname_copilot_short %} adoption
|
||||
|
||||
Planning and implementing an effective enablement process is essential to drive adoption of {% data variables.product.prodname_copilot_short %} in your organization. See [AUTOTITLE](/copilot/rolling-out-github-copilot-at-scale/driving-copilot-adoption-in-your-company).
|
||||
|
||||
## 6. Enhance the {% data variables.product.prodname_copilot_short %} experience
|
||||
|
||||
Enhance the {% data variables.product.prodname_copilot_short %} experience for your organization by:
|
||||
|
||||
* **Setting up knowledge bases** for use with {% data variables.copilot.copilot_chat_short %} _({% data variables.copilot.copilot_enterprise_short %} only)_. See [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-github-copilot-features-in-your-organization/managing-copilot-knowledge-bases).
|
||||
* **Installing {% data variables.copilot.copilot_extensions_short %}** to integrate other tools with {% data variables.copilot.copilot_chat_short %}. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-github-copilot-features-in-your-organization/installing-github-copilot-extensions-for-your-organization).
|
||||
* **Adding {% data variables.copilot.copilot_coding_agent %}** as a team member to work asynchronously on issues. See [AUTOTITLE](/copilot/rolling-out-github-copilot-at-scale/enabling-developers/using-copilot-coding-agent-in-org).
|
||||
@@ -0,0 +1,60 @@
|
||||
---
|
||||
title: Setting up GitHub Copilot for yourself
|
||||
shortTitle: Set up for self
|
||||
intro: Follow these steps to start using Copilot.
|
||||
permissions: Individuals
|
||||
versions:
|
||||
feature: copilot
|
||||
topics:
|
||||
- Copilot
|
||||
redirect_from:
|
||||
- /copilot/setting-up-github-copilot/setting-up-github-copilot-for-yourself
|
||||
---
|
||||
|
||||
## 1. Get access to {% data variables.product.prodname_copilot %}
|
||||
|
||||
There are a few ways that you can get access to {% data variables.product.prodname_copilot %}:
|
||||
|
||||
* **Use {% data variables.copilot.copilot_free_short %}**. Get a limited experience of {% data variables.product.prodname_copilot_short %} with up to 2,000 code completion requests and 50 premium requests per month-no paid plan required. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/about-github-copilot-free).
|
||||
|
||||
* **Sign up for a paid plan**. You can subscribe to either:
|
||||
|
||||
* **{% data variables.copilot.copilot_pro_short %}**, which includes a <a href="https://github.com/github-copilot/signup?ref_cta=Copilot+trial&ref_loc=about+github+copilot&ref_page=docs" target="_blank"><span>one-time 30-day free trial</span></a> and 300 monthly premium requests.
|
||||
* **{% data variables.copilot.copilot_pro_plus_short %}**, which includes 1,500 monthly premium requests and full access to all available models. [Subscribe to {% data variables.copilot.copilot_pro_plus_short %}](https://github.com/github-copilot/signup?ref_cta=Copilot+Pro%2B&ref_loc=subscriptions+page&ref_page=docs).
|
||||
|
||||
* **Use {% data variables.product.prodname_copilot_short %} through your organization or enterprise**. If you're part of an organization or enterprise with a {% data variables.product.prodname_copilot_short %} plan, you can request access at [https://github.com/settings/copilot](https://github.com/settings/copilot) under "Get {% data variables.product.prodname_copilot_short %} from an organization."
|
||||
|
||||
* **Verified students, teachers, or open source maintainers**. You may be eligible to use {% data variables.product.prodname_copilot_short %} for free. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-free-access-to-copilot-as-a-student-teacher-or-maintainer).
|
||||
|
||||
## 2. Install the {% data variables.product.prodname_copilot_short %} extension for your IDE
|
||||
|
||||
If you want to use {% data variables.product.prodname_copilot_short %} in your IDE, install the {% data variables.product.prodname_copilot_short %} extension for your IDE. See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/installing-the-github-copilot-extension-in-your-environment).
|
||||
|
||||
## 3. Install the {% data variables.product.prodname_copilot_short %} extension for the command line
|
||||
|
||||
If you want to use {% data variables.product.prodname_copilot_short %} in the command line, install the {% data variables.product.prodname_copilot_short %} extension for the {% data variables.product.prodname_cli %}. See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/installing-github-copilot-in-the-cli).
|
||||
|
||||
## 4. Use {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_windows_terminal %}
|
||||
|
||||
If you want to chat with {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_windows_terminal %}, connect {% data variables.product.prodname_copilot_short %} with Terminal Chat in {% data variables.product.prodname_windows_terminal %} Canary. See [AUTOTITLE](/copilot/quickstart?tool=windowsterminal).
|
||||
|
||||
## 5. Set up networking (if necessary)
|
||||
|
||||
If you connect through an HTTP proxy server or firewall, ensure that key URLs are added to the allowlist for the proxy server or firewall. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-your-proxy-server-or-firewall-for-copilot).
|
||||
|
||||
You may also need to install a custom SSL certificate on your machine. See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-network-settings-for-github-copilot#installing-custom-certificates).
|
||||
|
||||
## 6. Configure settings (optional)
|
||||
|
||||
All users can configure {% data variables.product.prodname_copilot_short %} settings in their IDE or in the CLI. See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-your-environment) and [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-the-cli).
|
||||
|
||||
If you have your own {% data variables.product.prodname_copilot_short %} plan (instead of using your organization or enterprise's plan), you can:
|
||||
|
||||
* **Install {% data variables.copilot.copilot_extensions_short %}** to integrate other tools with {% data variables.copilot.copilot_chat_short %}. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/installing-github-copilot-extensions-for-your-personal-account).
|
||||
* **Manage policies**. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-policies-as-an-individual-subscriber).
|
||||
|
||||
## 7. Start using {% data variables.product.prodname_copilot_short %}
|
||||
|
||||
Start using {% data variables.product.prodname_copilot_short %} to help you write code faster and more efficiently. For all the ways you can use {% data variables.product.prodname_copilot_short %}, see [AUTOTITLE](/copilot/using-github-copilot). {% data variables.product.prodname_copilot_short %} code suggestions, {% data variables.copilot.copilot_chat_dotcom_short %}, and {% data variables.copilot.copilot_chat_short %} in your IDE are a great place to start.
|
||||
|
||||
To learn how to best use {% data variables.product.prodname_copilot_short %}, see [AUTOTITLE](/copilot/using-github-copilot/best-practices-for-using-github-copilot) and [AUTOTITLE](/copilot/using-github-copilot/copilot-chat/prompt-engineering-for-copilot-chat).
|
||||
83
content/copilot/get-started/what-is-github-copilot.md
Normal file
83
content/copilot/get-started/what-is-github-copilot.md
Normal file
@@ -0,0 +1,83 @@
|
||||
---
|
||||
title: What is GitHub Copilot?
|
||||
intro: 'Learn what {% data variables.product.prodname_copilot %} is and what you can do with it.'
|
||||
versions:
|
||||
feature: copilot
|
||||
topics:
|
||||
- Copilot
|
||||
shortTitle: What is GitHub Copilot?
|
||||
redirect_from:
|
||||
- /copilot/copilot-individual
|
||||
- /copilot/copilot-individual/about-github-copilot-individual
|
||||
- /copilot/copilot-business/about-github-copilot-business
|
||||
- /copilot/github-copilot-enterprise/about-github-copilot-enterprise
|
||||
- /copilot/github-copilot-enterprise/overview
|
||||
- /copilot/overview-of-github-copilot/about-github-copilot-for-individuals
|
||||
- /copilot/overview-of-github-copilot/about-github-copilot
|
||||
- /copilot/overview-of-github-copilot/about-github-copilot-individual
|
||||
- /copilot/overview-of-github-copilot/about-github-copilot-for-business
|
||||
- /copilot/overview-of-github-copilot/about-github-copilot-business
|
||||
- /copilot/github-copilot-enterprise/overview/about-github-copilot-enterprise
|
||||
- /copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization
|
||||
- /copilot/managing-copilot-business
|
||||
- /copilot/managing-copilot-for-business
|
||||
- /copilot/github-copilot-enterprise
|
||||
- /copilot/copilot-business
|
||||
- /copilot/about-github-copilot/what-is-github-copilot
|
||||
---
|
||||
|
||||
{% data variables.product.prodname_copilot %} is an AI coding assistant that helps you write code faster and with less effort, allowing you to focus more energy on problem solving and collaboration.
|
||||
|
||||
{% data variables.product.prodname_copilot %} has been proven to increase developer productivity and accelerate the pace of software development. See [Research: quantifying {% data variables.product.prodname_copilot %}’s impact on developer productivity and happiness](https://github.blog/2022-09-07-research-quantifying-github-copilots-impact-on-developer-productivity-and-happiness/) in the {% data variables.product.prodname_dotcom %} blog.
|
||||
|
||||
## {% data variables.product.prodname_copilot_short %} features
|
||||
|
||||
{% data variables.product.prodname_copilot %} includes a suite of features. You can use {% data variables.product.prodname_copilot_short %} to:
|
||||
|
||||
* Get code suggestions as you type in your IDE
|
||||
* Chat with {% data variables.product.prodname_copilot_short %} to ask for help with your code
|
||||
* Ask {% data variables.product.prodname_copilot_short %} for help using the command line
|
||||
* Organize and share task-specific context with {% data variables.copilot.copilot_spaces %} to get more relevant answers
|
||||
* Generate a description of the changes in a pull request _({% data variables.copilot.copilot_enterprise_short %} only)_
|
||||
* Create and manage collections of documentation, called knowledge bases, to use as a context for chatting with {% data variables.product.prodname_copilot_short %} _({% data variables.copilot.copilot_enterprise_short %} only)_
|
||||
* Work on code changes and create a pull request for you to review _({% data variables.copilot.copilot_pro_plus_short %} and {% data variables.copilot.copilot_enterprise_short %} only)_
|
||||
|
||||
{% data variables.product.prodname_copilot_short %} is available:
|
||||
|
||||
* In your IDE
|
||||
* In {% data variables.product.prodname_mobile %}, as a chat interface
|
||||
* In {% data variables.product.prodname_windows_terminal %} Canary, through the Terminal Chat interface
|
||||
* On the command line, through the {% data variables.product.prodname_cli %}
|
||||
* On the {% data variables.product.github %} website
|
||||
|
||||
See [AUTOTITLE](/copilot/about-github-copilot/github-copilot-features).
|
||||
|
||||
## Getting access to {% data variables.product.prodname_copilot_short %}
|
||||
|
||||
There are a few ways you can start using {% data variables.product.prodname_copilot_short %}, depending on your role and needs.
|
||||
|
||||
### For individuals
|
||||
|
||||
* **Try {% data variables.product.prodname_copilot_short %} for free**: Use {% data variables.copilot.copilot_free_short %} to explore core {% data variables.product.prodname_copilot_short %} features with no paid plan required.
|
||||
* **Subscribe to a paid plan**: Upgrade to {% data variables.copilot.copilot_pro_short %} or {% data variables.copilot.copilot_pro_plus_short %} for full access to premium features and more generous usage limits. 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.copilot.copilot_pro_short %} for free</span></a> with a one-time 30-day trial.
|
||||
* **Eligible for free {% data variables.copilot.copilot_pro_short %} access?** Students, teachers, and open source maintainers may qualify for {% data variables.copilot.copilot_pro_short %} at no cost. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-free-access-to-copilot-as-a-student-teacher-or-maintainer).
|
||||
* **Organization members**: If your organization or enterprise has a {% data variables.product.prodname_copilot %} plan, you can request access to {% data variables.product.prodname_copilot_short %} by going to [https://github.com/settings/copilot](https://github.com/settings/copilot) and requesting access under "Get {% data variables.product.prodname_copilot_short %} from an organization."
|
||||
|
||||
See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-started-with-copilot-on-your-personal-account/getting-started-with-a-copilot-plan) for more information.
|
||||
|
||||
### For organizations and enterprises
|
||||
|
||||
* **Organization owners**: Purchase {% data variables.copilot.copilot_business_short %} for your team. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/subscribing-to-copilot-for-your-organization). If your organization is owned by an enterprise that has a {% data variables.product.prodname_copilot_short %} subscription, you can ask your enterprise owner to enable {% data variables.product.prodname_copilot_short %} for your organization by going to [https://github.com/settings/copilot](https://github.com/settings/copilot) and requesting access under "Get {% data variables.product.prodname_copilot_short %} from an organization."
|
||||
* **Enterprise owners**: Purchase {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} for your enterprise. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/subscribing-to-copilot-for-your-enterprise).
|
||||
|
||||
If you **don't need other {% data variables.product.github %} features**, you can request an enterprise account specifically for managing {% data variables.copilot.copilot_business_short %} licenses. These accounts don't include repository or organization creation and don’t incur {% data variables.product.prodname_enterprise %} seat charges. See [AUTOTITLE](/enterprise-cloud@latest/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).
|
||||
|
||||
## Next steps
|
||||
|
||||
* To learn more about the {% data variables.product.prodname_copilot_short %} features, see [AUTOTITLE](/copilot/about-github-copilot/github-copilot-features).
|
||||
* To start using {% data variables.product.prodname_copilot_short %}, see [AUTOTITLE](/copilot/setting-up-github-copilot).
|
||||
|
||||
## Further reading
|
||||
|
||||
* [Frequently asked questions](https://github.com/features/copilot#faq) about {% data variables.product.prodname_copilot %}
|
||||
* [{% data variables.product.prodname_copilot %} Trust Center](https://copilot.github.trust.page/)
|
||||
Reference in New Issue
Block a user