jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 09:57:42 -05:00
Code Issues Projects Releases Wiki Activity

Copilot CLI public preview (#57544)

Browse Source 
Co-authored-by: Ryan Hecht <ryanhecht@github.com>
Co-authored-by: Siara <108543037+SiaraMist@users.noreply.github.com>
Co-authored-by: Sarita Iyer <66540150+saritai@users.noreply.github.com>
This commit is contained in:
hubwriter
2025-09-25 16:20:34 +01:00
committed by GitHub
parent e1713a7d28
commit 2d3e463fe5
34 changed files with 694 additions and 334 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
assets/images/help/copilot/copilot-cli-welcome.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 162 KiB

276
content/copilot/concepts/agents/about-copilot-cli.md Normal file
View File

@@ -0,0 +1,276 @@
---
title: About GitHub Copilot CLI
shortTitle: Copilot CLI
allowTitleToDifferFromFilename: true
intro: 'Find out about using {% data variables.product.prodname_copilot_short %} from the command line.'
product: '{% data reusables.gated-features.copilot-cli %}'
versions:
feature: copilot
topics:
- Copilot
contentType: concepts
---
## Introduction
The command-line interface (CLI) for {% data variables.product.prodname_copilot %} allows you to use {% data variables.product.prodname_copilot_short %} directly from your terminal. You can use it to answer questions, write and debug code, and interact with {% data variables.product.prodname_dotcom_the_website %}. For example, you can ask {% data variables.product.prodname_copilot_short %} to make some changes to a project and create a pull request.
{% data variables.copilot.copilot_cli %} gives you quick access to a powerful AI agent, without having to leave your terminal. It can help you complete tasks more quickly by working on your behalf, and you can work iteratively with {% data variables.copilot.copilot_cli %} to build the code you need.
{% data reusables.cli.preview-note-cli %}
## Supported operating systems
* Linux
* macOS
* Windows from within [Windows Subsystem for Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/about). Native Windows support in Powershell is available, but experimental.
For installation instructions, see [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-cli).
## Modes of use
{% data variables.copilot.copilot_cli %} can be used in two modes:
* **Interactive mode**: Start an interactive session by using the `copilot` command. This is the default mode for working with the CLI.
In this mode, you can prompt {% data variables.product.prodname_copilot_short %} to answer a question, or perform a task. You can react to {% data variables.product.prodname_copilot_short %}'s responses in the same session.
![Screenshot of the Welcome message in the interactive mode of {% data variables.product.prodname_copilot_short %}.](/assets/images/help/copilot/copilot-cli-welcome.png)
* **Programmatic mode**: You can also pass the CLI a single prompt directly on the command line. You do this by using the `-p` or `--prompt` command-line option. To allow {% data variables.product.prodname_copilot_short %} to modify and execute files you should also use one of the approval options (see [Allowing tools to be used without manual approval](#allowing-tools-to-be-used-without-manual-approval) later in this article). For example:
```bash copy
copilot -p "List my open PRs" --allow-all-tools
```
Alternatively, you can use a script to output command-line options and pipe this to `copilot`. For example:
```bash copy
echo ./script-outputting-options.sh | copilot
```
> [!CAUTION]
> If you use an automatic approval option such as `--allow-all-tools`, {% data variables.product.prodname_copilot_short %} has the same access as you do to files on your computer, and can run any shell commands that you can run, without getting your prior approval. See [Security considerations](#security-considerations), later in this article.
## Use cases for {% data variables.copilot.copilot_cli %}
The following sections provide examples of tasks you can complete with {% data variables.copilot.copilot_cli %}.
### Local tasks
* From within a project directory you can ask {% data variables.product.prodname_copilot_short %} to make a change to the code in the project. For example:
`Change the background-color of H1 headings to dark blue`
{% data variables.product.prodname_copilot_short %} finds the CSS file where H1 headings are defined and changes the color value.
* Ask {% data variables.product.prodname_copilot_short %} to tell you about changes to a file:
`Show me the last 5 changes made to the CHANGELOG.md file. Who changed the file, when, and give a brief summary of the changes they made`
* Use {% data variables.product.prodname_copilot_short %} to help you improve the code, or documentation, in your project.
* `Suggest improvements to content.js`
* `Rewrite the readme in this project to make it more accessible to newcomers`
* Use {% data variables.product.prodname_copilot_short %} to help you perform Git operations.
* `Commit the changes to this repo`
* `Revert the last commit, leaving the changes unstaged`
* Ask {% data variables.product.prodname_copilot_short %} to create an application from scratch—for example, as a proof of concept.
`Use the create-next-app kit and tailwind CSS to create a next.js app. The app should be a dashboard built with data from the GitHub API. It should track this project's build success rate, average build duration, number of failed builds, and automated test pass rate. After creating the app, give me easy to follow instructions on how to build, run, and view the app in my browser.`
* Ask {% data variables.product.prodname_copilot_short %} to explain why a change it made is not working as expected, or tell {% data variables.product.prodname_copilot_short %} to fix a problem with the last change it made. For example:
`You said: "The application is now running on http://localhost:3002 and is fully functional!" but when I browse to that URL I get "This site can't be reached"`
### Tasks involving {% data variables.product.prodname_dotcom_the_website %}
* Fetch and display details about your work from {% data variables.product.prodname_dotcom_the_website %}.
* `List my open PRs`
This lists your open pull requests from any repository on GitHub. For more specific results, include the repository name in your prompt:
* `List all open issues assigned to me in OWNER/REPO`
* Ask {% data variables.product.prodname_copilot_short %} to work on an issue:
`I've been assigned this issue: https://github.com/octo-org/octo-repo/issues/1234. Start working on this for me in a suitably named branch.`
* Ask {% data variables.product.prodname_copilot_short %} to make file changes and raise a pull request on {% data variables.product.prodname_dotcom_the_website %}.
* `In the root of this repo, add a Node script called user-info.js that outputs information about the user who ran the script. Create a pull request to add this file to the repo on GitHub.`
* `Create a PR that updates the README at https://github.com/octo-org/octo-repo, changing the subheading "How to run" to "Example usage"`
Copilot creates a pull request on github.com, on your behalf. You are marked as the pull request author.
* Ask {% data variables.product.prodname_copilot_short %} to create an issue for you on {% data variables.product.prodname_dotcom_the_website %}.
``Raise an improvement issue in octo-org/octo-repo. In src/someapp/somefile.py the `file = open('data.txt', 'r')` block opens a file but never closes it.``
* Ask {% data variables.product.prodname_copilot_short %} to check the code changes in a pull request.
`Check the changes made in PR https://github.com/octo-org/octo-repo/pull/57575. Report any serious errors you find in these changes.`
Copilot responds in the CLI with a summary of any problems it finds.
* Manage pull requests from {% data variables.copilot.copilot_cli %}.
* `Merge all of the open PRs that I've created in octo-org/octo-repo`
* `Close PR #11 on octo-org/octo-repo`
* Find specific types of issues.
`Use the Github MCP server to find good first issues for a new team member to work on from octo-org/octo-repo`
> [!NOTE]
> If you know that a specific MCP server can achieve a particular task, then specifying it in your prompt can help {% data variables.product.prodname_copilot_short %} to deliver the results you want.
* Find specific {% data variables.product.prodname_actions %} workflows.
`List any Actions workflows in this repo that add comments to PRs`
* Create a {% data variables.product.prodname_actions %} workflow.
`Branch off from main and create a github actions workflow that will run on pull requests, or can be run manually. The workflow should run eslint to check for problems in the changes made in the PR. If warnings or errors are found these should be shown as messages in the diff view of the PR. I want to prevent code with errors from being merged into main so, if any errors are found, the workflow should cause the PR check to fail. Push the new branch and create a pull request.`
## Security considerations
When you use {% data variables.copilot.copilot_cli_short %}, {% data variables.product.prodname_copilot_short %} can perform tasks on your behalf, such as executing or modifying files, or running shell commands.
You should therefore always keep security considerations in mind when using {% data variables.copilot.copilot_cli_short %}, just as you would when working directly with files yourself, or running commands directly in your terminal. You should always review suggested commands carefully when {% data variables.copilot.copilot_cli_short %} requests your approval.
### Trusted directories
When you start a {% data variables.copilot.copilot_cli %} session, you'll be asked to confirm that you trust the files in, and below, the directory from which you launched the CLI.
> [!WARNING]
> * You should only launch {% data variables.copilot.copilot_cli_short %} from directories that you trust. You should not use {% data variables.copilot.copilot_cli_short %} in directories that may contain executable files you can't be sure you trust. Similarly, if you launch the CLI from a directory that contains sensitive or confidential data, or files that you don't want to be changed, you could inadvertently expose those files to risk. Typically, you should not launch {% data variables.copilot.copilot_cli_short %} from your home directory.
> * Scoping of permissions is heuristic and {% data variables.product.company_short %} does not guarantee that all files outside trusted directories will be protected. See [Risk mitigation](#risk-mitigation) later in this article.
You can choose to trust the current directory for:
* The currently running session only
* This and future sessions
If you choose to trust the directory for future sessions, the trusted directory prompt will not be displayed again. You should only choose this second option if you are sure that this location will always be a safe place for {% data variables.product.prodname_copilot_short %} to operate.
You can edit the list of permanently trusted directories by amending the contents of the `trusted_folders` array in the CLI's `config.json` file. This is located, by default, in the `~/.config` directory. You can change this location by setting the `XDG_CONFIG_HOME` environment variable.
### Allowed tools
The first time that {% data variables.product.prodname_copilot_short %} needs to use a tool that could be used to modify or execute a file—{% data reusables.cli.tools-needing-approval %}—it will ask you whether you want to allow it to use that tool.
Typically, you can choose from three options:
```text
1. Yes
2. Yes, and approve TOOL for the rest of the running session
3. No, and tell Copilot what to do differently (Esc)
```
**Option 1** allows {% data variables.product.prodname_copilot_short %} to run this particular command, this time only. The next time it needs to use this tool, it will ask you again.
**Option 2** allows {% data variables.product.prodname_copilot_short %} to use this tool again, without asking you for permission, for the duration of the currently running session. It will ask for your approval again in new sessions, or if you resume the current session in the future. If you choose this option, you are allowing {% data variables.product.prodname_copilot_short %} to use this tool in any way it thinks is appropriate. For example, if {% data variables.product.prodname_copilot_short %} asks you to allow it to run the command `rm ./this-file.txt`, and you choose option 2, then {% data variables.product.prodname_copilot_short %} can run any `rm` command (for example, `rm -rf ./*`) during the current run of this session, without asking for your approval.
**Option 3** cancels the proposed command and allows you to tell {% data variables.product.prodname_copilot_short %} to try a different approach.
#### Allowing tools to be used without manual approval
There are three command-line options that you can use for either interactive or programmatic mode to determine tools that {% data variables.product.prodname_copilot_short %} can use without asking for your approval:
* **`--allow-all-tools`**
Allows {% data variables.product.prodname_copilot_short %} to use any tool without asking for your approval.
For example, you can use this option with programmatic mode to allow the CLI to run any command. For example:
```shell
copilot -p "Revert the last commit" --allow-all-tools
```
* **`--deny-tool`**
Prevents {% data variables.product.prodname_copilot_short %} from using a specific tool.
This option takes precedence over the `--allow-all-tools` and `--allow-tool` options.
* **`--allow-tool`**
Allows {% data variables.product.prodname_copilot_short %} to use a specific tool without asking for your approval.
#### Using the approval options
The `--deny-tool` and `--allow-tool` options require one of the following arguments:
* `'shell(COMMAND)'`
For example, `copilot --deny-tool 'shell(rm)'` prevents {% data variables.product.prodname_copilot_short %} from using any `rm` command.
For `git` and `gh` commands, you can specify a particular first-level subcommand to allow or deny. For example:
```shell
copilot --deny-tool 'shell(git push)'
```
The tool specification is optional. For example, `copilot --allow-tool 'shell'` allows {% data variables.product.prodname_copilot_short %} to use any shell command without individual approval.
* `'write'`
This argument allows or denies tools—other than shell commands—permission to modify files.
For example, `copilot --allow-tool 'write'` allows {% data variables.product.prodname_copilot_short %} to edit files without your individual approval.
* `'MCP_SERVER_NAME'`
This argument allows or denies tools from the specified MCP server, where `MCP_SERVER_NAME` is the name of an MCP server that you have configured. Tools from the server are specified in parentheses, using the tool name that is registered with the MCP server. Using the server name without specifying a tool allows or denies all tools from that server.
For example, `copilot --deny-tool 'My-MCP-Server(tool_name)'` prevents {% data variables.product.prodname_copilot_short %} from using the tool called `tool_name` from the MCP server called `My-MCP-Server`.
You can find an MCP server's name by entering `/mcp` in the interactive mode of {% data variables.copilot.copilot_cli_short %} and selecting the server from the list that's displayed.
#### Combining approval options
You can use a combination of approval options to determine exactly which tools {% data variables.product.prodname_copilot_short %} can use without asking for your approval.
For example, to prevent {% data variables.product.prodname_copilot_short %} from using the `rm` and `git push` commands, but automatically allow all other tools, use:
```shell
copilot --allow-all-tools --deny-tool 'shell(rm)' --deny-tool 'shell(git push)'
```
To prevent {% data variables.product.prodname_copilot_short %} from using the tool `tool_name` from the MCP server named `My-MCP-Server`, but allow all other tools from that server to be used without individual approval, use:
```shell
copilot --allow-tool 'My-MCP-Server' --deny-tool 'My-MCP-Server(tool_name)'
```
#### Security implications of automatic tool approval
It's important to be aware of the security implications of using the approval command-line options. These options allow {% data variables.product.prodname_copilot_short %} to execute commands needed to complete your request, without giving you the opportunity to review and approve those commands before they are run. While this streamlines workflows, and allows headless operation of the CLI, it increases the risk of unintended actions being taken that might result in data loss or corruption, or other security issues.
### Risk mitigation
You can mitigate the risks associated with using the automatic approval options by using {% data variables.copilot.copilot_cli_short %} in a restricted environment, such as a virtual machine, container, or dedicated system, without internet access. This confines any potential damage that could occur when allowing {% data variables.product.prodname_copilot_short %} to execute commands that you have not reviewed and verified.
## Model usage
The default model used by {% data variables.copilot.copilot_cli %} is {% data variables.copilot.cca_current_model %}. {% data variables.product.github %} reserves the right to change this model.
You can change the model to {% data variables.copilot.copilot_gpt_5 %} by setting the `COPILOT_MODEL` environment variable to `gpt-5`.
Each time you submit a prompt to {% data variables.product.prodname_copilot_short %} in {% data variables.copilot.copilot_cli_short %}'s interactive mode, and each time you use {% data variables.copilot.copilot_cli_short %} in programmatic mode, your monthly quota of {% data variables.product.prodname_copilot_short %} premium requests is reduced by one. For information about premium requests, see [AUTOTITLE](/copilot/managing-copilot/monitoring-usage-and-entitlements/about-premium-requests).
{% data reusables.cli.feedback %}
## Further reading
* [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-cli)
* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/use-copilot-cli)
* [AUTOTITLE](/enterprise-cloud@latest/copilot/responsible-use/copilot-cli)

2
content/copilot/concepts/agents/coding-agent/about-coding-agent.md
View File

@@ -140,6 +140,8 @@ Users can include hidden messages in issues assigned to {% data variables.produc
* **{% data variables.copilot.copilot_coding_agent %} only works with repositories hosted on {% data variables.product.github %}**. If your repository is stored using a different code hosting platform, {% data variables.product.prodname_copilot_short %} won't be able to work on it.
* **You cannot change the AI model used by {% data variables.copilot.copilot_coding_agent %}**. The model is determined by {% data variables.product.company_short %} and does not inherit the model selected for {% data variables.copilot.copilot_chat %}.
Currently the model used by {% data variables.copilot.copilot_coding_agent %} is {% data variables.copilot.cca_current_model %}. {% data variables.product.github %} reserves the right to change this model.
## Hands-on practice
Try the [Expand your team with {% data variables.copilot.copilot_coding_agent %}](https://github.com/skills/expand-your-team-with-copilot/) Skills exercise for practical experience with {% data variables.copilot.copilot_coding_agent %}.

2
content/copilot/concepts/agents/index.md
View File

@@ -10,6 +10,6 @@ topics:
children:
- /coding-agent
- /code-review
- /about-copilot-cli
contentType: concepts
---

1
content/copilot/concepts/billing/copilot-requests.md
View File

@@ -43,6 +43,7 @@ The following {% data variables.product.prodname_copilot_short %} features can u
| [{% data variables.copilot.copilot_extensions_short %}](/copilot/concepts/copilot-extensions/about-copilot-extensions) | {% data variables.copilot.copilot_extensions_short %} uses **one premium request** per user prompt, multiplied by the model's rate. |
| [{% data variables.copilot.copilot_spaces %}](/copilot/using-github-copilot/copilot-spaces/about-organizing-and-sharing-context-with-copilot-spaces) | {% data variables.copilot.copilot_spaces %} uses **one premium request** per user prompt, multiplied by the model's rate. |
| [{% data variables.product.prodname_spark_short %}](/copilot/tutorials/building-ai-app-prototypes) | Each prompt to {% data variables.product.prodname_spark_short %} uses a fixed rate of **four premium requests**. |
| [{% data variables.copilot.copilot_cli_short %}](/copilot/concepts/agents/about-copilot-cli) | Each prompt to {% data variables.copilot.copilot_cli_short %} uses **one premium request**. |
## How do request allowances work per plan?

23
content/copilot/concepts/chat.md
View File

@@ -19,9 +19,10 @@ contentType: concepts
{% data variables.copilot.copilot_chat %} is available in various environments:
* {% data variables.product.github %} (the website).
* A range of IDEs such as {% data variables.product.prodname_vscode %}, Xcode, and JetBrains IDEs.
* {% data variables.product.prodname_mobile %}.
* {% data variables.product.github %} (the website)
* A range of IDEs such as {% data variables.product.prodname_vscode %}, Xcode, and JetBrains IDEs
* {% data variables.product.prodname_mobile %}
* {% data variables.copilot.copilot_cli %}
Different environments may have different features and capabilities, but the core functionality remains consistent across platforms. To explore the functionality available in each environment, see the [AUTOTITLE](/copilot/how-tos/chat) how-to guides and the [AUTOTITLE](/copilot/tutorials).
@@ -33,11 +34,13 @@ Different environments may have different features and capabilities, but the cor
{% data variables.product.prodname_copilot %} in {% data variables.product.github %}, {% data variables.product.prodname_vscode %}, and {% data variables.product.prodname_vs %} can provide chat responses that are tailored to the way your team works, the tools you use, the specifics of your project, or your personal preferences, if you provide it with enough context to do so. Instead of repeating instructions in each prompt, you can create and save instructions for {% data variables.copilot.copilot_chat_short %} to customize what responses you receive.
There are two types of custom instructions you can add for {% data variables.copilot.copilot_chat_short %}:
* Repository instructions: You can create a custom instructions file for a repository, so that all prompts asked in the context of the repository automatically include the instructions you've defined
* Personal instructions: You can add personal instructions so that all the chat responses you, as a user, receive are tailored to your preferences
There are various ways you can create custom instructions for {% data variables.copilot.copilot_chat_short %}. These fall into three main categories:
For more information, see [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot) and [AUTOTITLE](/copilot/customizing-copilot/adding-personal-custom-instructions-for-github-copilot).
* **Personal instructions**: You can add personal instructions so that all the chat responses you, as a user, receive are tailored to your preferences.
* **Repository instructions**: You can store instructions files in a repository, so that all prompts asked in the context of the repository automatically include the instructions you've defined.
* **Organization instructions**: If you are an organization owner, you can create a custom instructions file for an organization, so that all prompts asked in the context of any repository owned by the organization automatically include the instructions you've defined.
For more information, see [AUTOTITLE](/copilot/customizing-copilot/adding-personal-custom-instructions-for-github-copilot), [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot) and [AUTOTITLE](/copilot/customizing-copilot/adding-organization-custom-instructions-for-github-copilot).
## AI models for {% data variables.copilot.copilot_chat_short %}
@@ -56,3 +59,9 @@ You can configure MCP servers to provide context to {% data variables.copilot.co
### Extending {% data variables.copilot.copilot_chat_short %} with external tools
{% data reusables.copilot.copilot-extensions.extending-copilot-chat %}
### Further reading
* [AUTOTITLE](/copilot/how-tos/chat-with-copilot) how-to guides
* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/use-copilot-cli)
* [AUTOTITLE](/copilot/tutorials/copilot-chat-cookbook)

6
content/copilot/get-started/features.md
View File

@@ -33,9 +33,9 @@ An autonomous AI agent that can make code changes for you. You can assign a {% d
### {% 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).
A command line interface that lets you use {% data variables.product.prodname_copilot_short %} from within the terminal. You can get answers to questions, or you can ask {% data variables.product.prodname_copilot_short %} to make changes to your local files. You can also use {% data variables.copilot.copilot_cli_short %} to interact with {% data variables.product.prodname_dotcom_the_website %}—for example, listing your open pull requests, or asking {% data variables.product.prodname_copilot_short %} to create an issue. See [AUTOTITLE](/copilot/concepts/agents/about-copilot-cli).
### {% data variables.product.prodname_copilot %} code review
### {% data variables.copilot.copilot_code-review_short %}
AI-generated code review suggestions to help you write better code. See [AUTOTITLE](/copilot/using-github-copilot/code-review/using-copilot-code-review).
@@ -47,7 +47,7 @@ AI-generated summaries of the changes that were made in a pull request, which fi
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 variables.copilot.copilot_extensions_short %}
{% data reusables.copilot.copilot-extensions.copilot-extensions-intro %} See [AUTOTITLE](/copilot/concepts/copilot-extensions/about-copilot-extensions).

2
content/copilot/how-tos/configure-custom-instructions/add-organization-instructions.md
View File

@@ -35,7 +35,7 @@ Some examples of instructions you could add are:
> [!NOTE]
> * {% data reusables.copilot.custom-instructions-chat-precedence %}
> * For {% data variables.copilot.copilot_code-review_short %}, the order of precedence is: instructions in any applicable `.github/instructions/NAME.instructions.md` file, then the instructions in the `.github/copilot-instructions.md` file, then the organization-level custom instructions.
> * For {% data variables.copilot.copilot_code-review_short %}, the order of precedence is: instructions in any applicable `.github/instructions/**/NAME.instructions.md` file, then the instructions in the `.github/copilot-instructions.md` file, then the organization-level custom instructions.
> * {% data reusables.copilot.custom-instructions-conflict %}
## Adding organization custom instructions

4
content/copilot/how-tos/configure-custom-instructions/add-repository-instructions.md
View File

@@ -261,9 +261,9 @@ You can create several types of repository custom instructions for use on {% dat
* **Agent instructions** are used by AI agents.
Supported by: **{% data variables.copilot.copilot_coding_agent %}**.
Supported by: **{% data variables.copilot.copilot_coding_agent %}** and {% data variables.copilot.copilot_cli_short %}.
You can create one or more `AGENTS.md` files, stored anywhere within the repository. When {% data variables.product.prodname_copilot_short %} is working, the nearest `AGENTS.md` file in the directory tree will take precedence.
You can create one or more `AGENTS.md` files, stored anywhere within the repository. When {% data variables.product.prodname_copilot_short %} is working, the nearest `AGENTS.md` file in the directory tree will take precedence. For more information, see the [openai/agents.md repository](https://github.com/openai/agents.md).
Alternatively, you can use a single `CLAUDE.md` or `GEMINI.md` file stored in the root of the repository.

88
content/copilot/how-tos/configure-personal-settings/customize-copilot-in-the-cli.md
View File

@@ -1,88 +0,0 @@
---
title: Customizing GitHub Copilot in the CLI
shortTitle: Customize Copilot in the CLI
intro: 'Learn how to customize and set up aliases for {% data variables.copilot.copilot_cli_short %}.'
versions:
feature: copilot-in-the-cli
topics:
- Copilot
- CLI
redirect_from:
- /copilot/github-copilot-in-the-cli/configuring-github-copilot-in-the-cli
- /copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-the-cli
- /copilot/how-tos/personal-settings/configuring-github-copilot-in-the-cli
- /copilot/how-tos/personal-settings/customizing-github-copilot-in-the-cli
- /copilot/how-tos/personal-settings/customize-copilot-in-the-cli
contentType: how-tos
---
Before you begin, make sure you have installed {% data variables.copilot.copilot_cli_short %}. See [AUTOTITLE](/copilot/how-tos/set-up/installing-github-copilot-in-the-cli).
## Setting up aliases
You can create aliases for {% data variables.copilot.copilot_cli_short %} to reduce keystrokes, and to allow {% data variables.copilot.copilot_cli_short %} to execute commands on your behalf.
To allow {% data variables.copilot.copilot_cli_short %} to execute commands, you must run the following commands to create the aliases (as opposed to creating an alias like you would for another shell command).
After executing the following commands to create the aliases, you can run `ghcs` and `ghce` instead of `gh copilot suggest` and `gh copilot explain`.
### Bash
```shell copy
echo 'eval "$(gh copilot alias -- bash)"' >> ~/.bashrc
```
### PowerShell
```shell copy
$GH_COPILOT_PROFILE = Join-Path -Path $(Split-Path -Path $PROFILE -Parent) -ChildPath "gh-copilot.ps1"
gh copilot alias -- pwsh | Out-File ( New-Item -Path $GH_COPILOT_PROFILE -Force )
echo ". `"$GH_COPILOT_PROFILE`"" >> $PROFILE
```
### Zsh
```shell copy
echo 'eval "$(gh copilot alias -- zsh)"' >> ~/.zshrc
```
## Changing the default execution confirmation
When you use the `ghcs` alias and you select **Execute command**, {% data variables.copilot.copilot_cli_short %} will ask for confirmation before executing the command. You can change the default confirmation.
1. Execute the following command:
```shell copy
gh copilot config
```
1. Select **Default value for confirming command execution**.
1. Choose the desired default.
## Changing usage analytics
Unless you opt out, {% data variables.copilot.copilot_cli_short %} will send a payload in the format below to the analytics system. This data helps improve the product. {% data variables.product.company_short %} does not look at the data of specific individuals or at specific queries.
```json
{
"platform": "darwin",
"architecture": "arm64",
"version": "0.3.0-beta",
"custom_event": "true",
"event_parent_command": "explain",
"event_name": "Explain",
"sha": "089a53215fc4383179869f7f6132ce9d6e58754a",
"thread_id": "e61d0d08-f6ba-465b-81cf-c30fd9127d70"
}
```
To opt in or out of data collection:
1. Execute the following command:
```shell copy
gh copilot config
```
1. Select **Optional Usage Analytics**.
1. Choose the desired default.

2
content/copilot/how-tos/configure-personal-settings/index.md
View File

@@ -8,7 +8,6 @@ topics:
children:
- /configure-network-settings
- /configure-in-ide
- /customize-copilot-in-the-cli
- /authenticate-to-ghecom
redirect_from:
- /copilot/configuring-github-copilot
@@ -16,4 +15,3 @@ redirect_from:
- /copilot/how-tos/personal-settings
contentType: how-tos
---

1
content/copilot/how-tos/index.md
View File

@@ -26,4 +26,3 @@ redirect_from:
- /copilot/using-github-copilot
contentType: how-tos
---

3
content/copilot/how-tos/set-up/index.md
View File

@@ -11,10 +11,9 @@ children:
- /set-up-for-organization
- /set-up-for-enterprise
- /install-copilot-extension
- /install-copilot-in-the-cli
- /install-copilot-cli
redirect_from:
- /copilot/setting-up-github-copilot
- /copilot/get-started/setting-up-github-copilot
contentType: how-tos
---

43
content/copilot/how-tos/set-up/install-copilot-cli.md Normal file
View File

@@ -0,0 +1,43 @@
---
title: Installing GitHub Copilot CLI
shortTitle: Install Copilot CLI
intro: 'Learn how to install {% data variables.copilot.copilot_cli_short %} so that you can use {% data variables.product.prodname_copilot_short %} directly from the command line.'
versions:
feature: copilot
topics:
- Copilot
- CLI
redirect_from:
- /copilot/how-tos/set-up/install-copilot-in-the-cli
- /copilot/github-copilot-in-the-cli/enabling-github-copilot-in-the-cli
- /copilot/github-copilot-in-the-cli/setting-up-github-copilot-in-the-cli
- /copilot/github-copilot-in-the-cli/installing-github-copilot-in-the-cli
- /copilot/managing-copilot/configure-personal-settings/installing-github-copilot-in-the-cli
- /copilot/how-tos/personal-settings/installing-github-copilot-in-the-cli
- /copilot/how-tos/set-up/installing-github-copilot-in-the-cli
contentType: how-tos
---
{% data reusables.cli.preview-note-cli %}
To find out about {% data variables.copilot.copilot_cli_short %} before you install it, see [AUTOTITLE](/copilot/concepts/agents/about-copilot-cli).
## Prerequisites
* **A {% data variables.product.prodname_copilot %} subscription**. See [Copilot plans](https://github.com/features/copilot/plans?ref_cta=Copilot+plans+signup&ref_loc=install-copilot-cli&ref_page=docs).
* **Node.js** version 22 or later
* **npm** version 10 or later
If you have access to {% data variables.product.prodname_copilot %} via your organization or enterprise, you cannot use {% data variables.copilot.copilot_cli_short %} if your organization owner or enterprise administrator has disabled it in the organization or enterprise settings. 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).
## Installing or updating {% data variables.copilot.copilot_cli_short %}
Run the following command to install or update {% data variables.copilot.copilot_cli_short %}.
```shell copy
npm install -g @github/copilot
```
## Next steps
You can now use {% data variables.product.prodname_copilot_short %} from the command line. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/use-copilot-cli).

52
content/copilot/how-tos/set-up/install-copilot-in-the-cli.md
View File

@@ -1,52 +0,0 @@
---
title: Installing GitHub Copilot in the CLI
intro: 'Learn how to install {% data variables.copilot.copilot_cli_short %} so that you can get suggestions and explanations for the command line.'
versions:
feature: copilot-in-the-cli
topics:
- Copilot
- CLI
shortTitle: Install Copilot in the CLI
redirect_from:
- /copilot/github-copilot-in-the-cli/enabling-github-copilot-in-the-cli
- /copilot/github-copilot-in-the-cli/setting-up-github-copilot-in-the-cli
- /copilot/github-copilot-in-the-cli/installing-github-copilot-in-the-cli
- /copilot/managing-copilot/configure-personal-settings/installing-github-copilot-in-the-cli
- /copilot/how-tos/personal-settings/installing-github-copilot-in-the-cli
- /copilot/how-tos/set-up/installing-github-copilot-in-the-cli
contentType: how-tos
---
## Prerequisites
* **Access to {% data variables.product.prodname_copilot %}**. See [AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot#getting-access-to-copilot).
* **{% data variables.product.prodname_cli %} installed.** {% data reusables.cli.cli-installation %}
If you have access to {% data variables.product.prodname_copilot %} via your organization or enterprise, you cannot use {% data variables.copilot.copilot_cli_short %} if your organization owner or enterprise administrator has disabled {% data variables.copilot.copilot_cli_short %}. 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).
## Installing {% data variables.copilot.copilot_cli_short %}
1. If you have not already authenticated to the {% data variables.product.prodname_cli %}, run the following command in your terminal.
```shell copy
gh auth login
```
1. To install the {% data variables.copilot.copilot_cli_short %} extension, run the following command.
```shell copy
gh extension install github/gh-copilot
```
## Updating {% data variables.copilot.copilot_cli_short %}
After installing the {% data variables.copilot.copilot_cli_short %} extension, you can update at any time by running:
```shell copy
gh extension upgrade gh-copilot
```
## Further reading
* [AUTOTITLE](/copilot/github-copilot-in-the-cli/using-github-copilot-in-the-cli)
* [AUTOTITLE](/copilot/github-copilot-in-the-cli/configuring-github-copilot-in-the-cli)

2
content/copilot/how-tos/set-up/set-up-for-self.md
View File

@@ -49,7 +49,7 @@ You may also need to install a custom SSL certificate on your machine. See [AUTO
## 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).
All users can configure {% data variables.product.prodname_copilot_short %} settings in their IDE. See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-your-environment).
If you have your own {% data variables.product.prodname_copilot_short %} plan (instead of using your organization or enterprise's plan), you can:

6
content/copilot/how-tos/troubleshoot-copilot/troubleshoot-common-issues.md
View File

@@ -63,12 +63,6 @@ If you cannot connect to the server, you can create a discussion in our [discuss
This is a known issue and our team is working towards a fix. For more information, see this comment on a [{% data variables.product.prodname_github_community %} discussion](https://github.com/orgs/community/discussions/40522#discussioncomment-4701470).
## Error: "No valid OAuth token detected" in {% data variables.copilot.copilot_cli %}
This error suggests that a classic or fine-grained {% data variables.product.pat_generic %} might be in use, either via the `GITHUB_TOKEN` or `GH_TOKEN` environment variables, or during a `gh auth login` attempt. {% data variables.copilot.copilot_cli %} currently only supports using the {% data variables.product.prodname_cli %} OAuth app.
For more information, see the [{% data variables.copilot.copilot_cli_short %} extension repository](https://github.com/github/gh-copilot).
## Error: "Sorry, your request was rate-limited."
This error suggests that you have exceeded the rate limit for {% data variables.product.prodname_copilot_short %} requests. {% data variables.product.github %} uses rate limits to ensure everyone has fair access to the {% data variables.product.prodname_copilot_short %} service and to protect against abuse.

2
content/copilot/how-tos/use-copilot-agents/index.md
View File

@@ -9,8 +9,8 @@ topics:
children:
- /coding-agent
- /request-a-code-review
- /use-copilot-cli
redirect_from:
- /copilot/how-tos/agents
contentType: how-tos
---

163
content/copilot/how-tos/use-copilot-agents/use-copilot-cli.md Normal file
View File

@@ -0,0 +1,163 @@
---
title: Using GitHub Copilot CLI
shortTitle: Use Copilot CLI
intro: Learn how to use {% data variables.product.prodname_copilot %} from the command line.
product: '{% data reusables.gated-features.copilot-cli %}'
versions:
feature: copilot
topics:
- Copilot
- CLI
contentType: how-tos
---
The command-line interface (CLI) for {% data variables.product.prodname_copilot %} allows you to use {% data variables.product.prodname_copilot_short %} directly from your terminal. For more information, see [AUTOTITLE](/copilot/concepts/agents/about-copilot-cli).
{% data reusables.cli.preview-note-cli %}
## Prerequisite
Install {% data variables.copilot.copilot_cli_short %}. See [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-cli).
## Using {% data variables.copilot.copilot_cli_short %}
1. In your terminal, navigate to a folder that contains code you want to work with.
1. Enter `copilot` to start {% data variables.copilot.copilot_cli_short %}.
{% data variables.product.prodname_copilot_short %} will ask you to confirm that you trust the files in this folder.
> [!IMPORTANT]
> During this {% data variables.copilot.copilot_cli %} session, {% data variables.product.prodname_copilot_short %} may attempt to read, modify, and execute files in and below this folder. You should only proceed if you trust the files in this location. For more information about trusted directories, see [AUTOTITLE](/copilot/concepts/agents/about-copilot-cli#trusted-directories).
1. Choose one of the options:
**1. Yes, proceed**:
{% data variables.product.prodname_copilot_short %} can work with the files in this location for this session only.
**2. Yes, and remember this folder for future sessions**:
You trust the files in this folder for this and future sessions. You won't be asked again when you start {% data variables.copilot.copilot_cli_short %} from this folder. Only choose this option if you are sure that it will always be safe for {% data variables.product.prodname_copilot_short %} to work with files in this location.
**3. No, exit (Esc)**:
End your {% data variables.copilot.copilot_cli_short %} session.
1. If you are not currently logged in to {% data variables.product.github %}, you'll be prompted to use the `/login` slash command. Enter this command and follow the on-screen instructions to authenticate.
1. Enter a prompt in the CLI.
This can be a simple chat question, or a request for {% data variables.product.prodname_copilot_short %} to perform a specific task, such as fixing a bug, adding a feature to an existing application, or creating a new application.
For some examples of prompts, see [AUTOTITLE](/copilot/concepts/agents/about-copilot-cli).
1. When {% data variables.product.prodname_copilot_short %} wants to use a tool that could modify or execute files—{% data reusables.cli.tools-needing-approval %}—it will ask you to approve the use of the tool.
Choose one of the options:
**1. Yes**:
Allow {% data variables.product.prodname_copilot_short %} to use this tool. The next time {% data variables.product.prodname_copilot_short %} wants to use this tool, it will ask you to approve it again.
**2. Yes, and approve TOOL for the rest of the running session**:
Allow {% data variables.product.prodname_copilot_short %} to use this tool—with any options—without asking again, for the rest of the currently running session. You will have to approve the command again in future sessions.
Choosing this option is useful for a many tools—such as `chmod`—as it avoids you having to approve similar commands repeatedly in the same session. However, you should be aware of the security implications of this option. Choosing this option for the command `rm`, for example, would allow {% data variables.product.prodname_copilot_short %} to delete any file in or below the current folder without asking for your approval.
**3. No, and tell Copilot what to do differently (Esc)**:
{% data variables.product.prodname_copilot_short %} will not run the command. Instead, it ends the current operation and awaits your next prompt. You can tell {% data variables.product.prodname_copilot_short %} to continue the task but using a different approach.
For example, if you ask {% data variables.product.prodname_copilot_short %} to create a bash script but you do not want to use the script {% data variables.product.prodname_copilot_short %} suggests, you can stop the current operation and enter a new prompt, such as: `Continue the previous task but include usage instructions in the script`.
## Tips
Optimize your experience with {% data variables.copilot.copilot_cli_short %} with the following tips.
### Stop a currently running operation
If you enter a prompt and then decide you want to stop {% data variables.product.prodname_copilot_short %} from completing the task while it is still "Thinking," press <kbd>Esc</kbd>.
### Include a specific file in your prompt
To add a specific file to your prompt, use `@` followed by the relative path to the file. For example: `Explain @config/ci/ci-required-checks.yml` or `Fix the bug in @src/app.js`. This adds the contents of the file to your prompt as context for {% data variables.product.prodname_copilot_short %}.
When you start typing a file path, the matching paths are displayed below the prompt box. Use the arrow keys to select a path and press <kbd>Tab</kbd> to complete the path in your prompt.
### Work with files in a different location
To complete a task, {% data variables.product.prodname_copilot_short %} may need to work with files that are outside the current working directory. If a prompt you have entered in an interactive session requires {% data variables.product.prodname_copilot_short %} to modify a file outside the current location, it will ask you to approve access to the file's directory.
You can also add a trusted directory manually at any time by using the slash command:
```shell
/add-dir /path/to/directory
```
If all of the files you want to work with are in a different location, you can switch the current working directory without starting a new {% data variables.copilot.copilot_cli_short %} session by using the slash command:
```shell
/cwd /path/to/directory
```
### Resume an interactive session
You can return to a previous interactive session, and continue your conversation with {% data variables.product.prodname_copilot_short %}, by using the `--resume` command line option, then choosing the session you want to resume from the list that's displayed.
### Use custom instructions
You can enhance {% data variables.product.prodname_copilot_short %}’s performance, by adding custom instructions to the repository you are working in. Custom instructions are natural language descriptions saved in Markdown files in the repository. They are automatically included in prompts you enter while working in that repository. This helps {% data variables.product.prodname_copilot_short %} to better understand the context of your project and how to respond to your prompts.
{% data variables.copilot.copilot_cli_short %} supports:
* Repository-wide instructions in the `.github/copilot-instructions.md` file.
* Path-specific instructions files: `.github/copilot-instructions/**/*.instructions.md`.
* Agent files such as `AGENTS.md`.
For more information, see [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions).
### Add an MCP server
{% data variables.copilot.copilot_cli_short %} comes with the {% data variables.product.github %} MCP server already configured. This MCP server allows you to interact with resources on {% data variables.product.prodname_dotcom_the_website %}—for example, allowing you to merge pull requests from the CLI.
To extend the functionality available to you in {% data variables.copilot.copilot_cli_short %}, you can add more MCP servers:
1. Use the following slash command:
```shell
/mcp add
```
1. Fill in the details for the MCP server you want to add, using the <kbd>Tab</kbd> key to move between fields.
1. Press <kbd>Ctrl</kbd>+<kbd>S</kbd> to save the details.
Details of your configured MCP servers are stored in the `mcp-config.json` file, which is located, by default, in the `~/.config` directory. This location can be changed by setting the `XDG_CONFIG_HOME` environment variable. For information about the JSON structure of a server definition, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp#writing-a-json-configuration-for-mcp-servers).
## Find out more
For a complete list of the command line options and slash commands that you can use with {% data variables.copilot.copilot_cli_short %}, do one of the following:
* Enter `?` in the prompt box in an interactive session.
* Enter `copilot help` in your terminal.
For additional information use one of the following commands in your terminal:
* **Configuration settings**:
`copilot help config`
You can adjust the configuration settings by editing the `config.json` file, which is located, by default, in the `~/.config` directory. This location can be changed by setting the `XDG_CONFIG_HOME` environment variable.
* **Environment variables** that affect {% data variables.copilot.copilot_cli_short %}:
`copilot help environment`
* **Available logging levels**:
`copilot help logging`
* **Permissions** for allowing or denying tool use:
`copilot help permissions`
{% data reusables.cli.feedback %}

50
content/copilot/how-tos/use-copilot-for-common-tasks/use-copilot-in-the-cli.md
View File

@@ -1,12 +1,13 @@
---
title: Using GitHub Copilot in the command line
intro: 'You can use {% data variables.product.prodname_copilot_short %} with the {% data variables.product.prodname_cli %} to get suggestions and explanations for the command line.'
title: Using the GitHub CLI Copilot extension
shortTitle: Use Copilot in the CLI
allowTitleToDifferFromFilename: true
intro: 'This article provides details about the replacement for the {% data variables.product.prodname_copilot_short %} extension for {% data variables.product.prodname_cli %}.'
versions:
feature: copilot-in-the-cli
topics:
- Copilot
- CLI
shortTitle: Use Copilot in the CLI
redirect_from:
- /copilot/github-copilot-in-the-cli/using-github-copilot-in-the-cli
- /copilot/using-github-copilot/using-github-copilot-in-the-cli
@@ -14,46 +15,11 @@ redirect_from:
- /copilot/how-tos/github-flow/using-github-copilot-in-the-command-line
- /copilot/how-tos/github-flow/use-copilot-in-the-cli
- /copilot/github-copilot-in-the-cli
- /copilot/how-tos/configure-personal-settings/customize-copilot-in-the-cli
- /copilot/github-copilot-in-the-cli/configuring-github-copilot-in-the-cli
contentType: how-tos
---
## Prerequisites
# Replacing the deprecated {% data variables.product.prodname_copilot_short %} extension
* **Access to {% data variables.product.prodname_copilot %}**. See [AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot#getting-access-to-copilot).
* **{% data variables.product.prodname_cli %} installed**. {% data reusables.cli.cli-installation %}
* **{% data variables.copilot.copilot_cli_short %} extension installed**. See [AUTOTITLE](/copilot/github-copilot-in-the-cli/installing-github-copilot-in-the-cli).
If you have access to {% data variables.product.prodname_copilot %} via your organization or enterprise, you cannot use {% data variables.copilot.copilot_cli_short %} if your organization owner or enterprise administrator has disabled {% data variables.copilot.copilot_cli_short %}. 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).
## Getting command explanations
To ask {% data variables.copilot.copilot_cli_short %} to explain a command, run `gh copilot explain` followed by the command that you want explained. For example:
```shell copy
gh copilot explain "sudo apt-get"
```
## Getting command suggestions
To ask {% data variables.copilot.copilot_cli_short %} to suggest a command, run `gh copilot suggest` followed by the command that you want. For example:
```shell copy
gh copilot suggest "Undo the last commit"
```
{% data variables.copilot.copilot_cli_short %} will start an interactive session to get more information about what you want.
If you choose the **Execute command** option after {% data variables.copilot.copilot_cli_short %} suggests a command, {% data variables.copilot.copilot_cli_short %} will copy the command to your clipboard and exit the interactive session. Then you can manually paste the command into your CLI.
If you want {% data variables.copilot.copilot_cli_short %} to be able to execute commands on your behalf, you must set up the `ghcs` alias. See [AUTOTITLE](/copilot/github-copilot-in-the-cli/configuring-github-copilot-in-the-cli#setting-up-aliases).
## Sharing feedback
To send feedback to {% data variables.product.company_short %} about the quality of a suggestion, select the **Rate response** option in {% data variables.copilot.copilot_cli_short %}.
You can also open an issue in the [{% data variables.copilot.copilot_cli_short %} extension repository](https://github.com/github/gh-copilot).
## Further reading
* [{% data variables.copilot.copilot_cli_short %} extension README](https://github.com/github/gh-copilot?tab=readme-ov-file)
* [AUTOTITLE](/copilot/github-copilot-in-the-cli/configuring-github-copilot-in-the-cli)
The {% data variables.product.prodname_copilot %} extension for {% data variables.product.prodname_cli %} has been deprecated. It has been replaced by the new {% data variables.copilot.copilot_cli %}. See [AUTOTITLE](/copilot/concepts/agents/about-copilot-cli).

14
content/copilot/reference/policy-conflicts.md
View File

@@ -40,15 +40,15 @@ Feature, model, and privacy settings for users are set according to the **least
| :---- | :---- | :---- |
| {% data variables.product.prodname_copilot_short %} Metrics API | Most restrictive organization | [AUTOTITLE](/rest/copilot/copilot-metrics) |
| Suggestions matching public code (privacy policy) | Most restrictive organization | [AUTOTITLE](/copilot/concepts/completions/code-suggestions) |
| {% data variables.product.prodname_copilot_short %} can search the web | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-copilot-chat-in-github#leveraging-a-web-search-to-answer-a-question) |
| {% data variables.copilot.copilot_mobile_short %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-copilot-chat-in-github-mobile) |
| {% data variables.copilot.copilot_chat_short %} in the IDE | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-copilot-chat-in-your-ide) |
| {% data variables.product.prodname_copilot_short %} can search the web | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/chat-in-github#leveraging-a-web-search-to-answer-a-question) |
| {% data variables.copilot.copilot_mobile_short %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/chat-in-github-mobile) |
| {% data variables.copilot.copilot_chat_short %} in the IDE | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/chat-in-your-ide) |
| {% data variables.copilot.copilot_code-review_short %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/code-review) |
| {% data variables.copilot.copilot_coding_agent %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use-of-github-copilot-features/responsible-use-of-copilot-coding-agent-on-githubcom) |
| {% data variables.copilot.copilot_coding_agent %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/copilot-coding-agent) |
| {% data variables.copilot.copilot_extensions_short %} | Least restrictive organization | [AUTOTITLE](/copilot/concepts/copilot-extensions/about-copilot-extensions) |
| {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_dotcom_the_website %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-copilot-chat-in-github) |
| {% data variables.copilot.copilot_desktop_short %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-copilot-in-github-desktop) |
| {% data variables.copilot.copilot_cli_short %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-copilot-in-the-cli) |
| {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_dotcom_the_website %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/chat-in-github) |
| {% data variables.copilot.copilot_desktop_short %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/copilot-in-github-desktop) |
| {% data variables.copilot.copilot_cli_short %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/copilot-cli) |
| Editor preview features | Least restrictive organization | [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-pre-release-license-terms) |
| {% data variables.product.prodname_github_models %}, one policy per model | Least restrictive organization | [AUTOTITLE](/github-models/github-models-at-scale/manage-models-at-scale) |
| MCP servers in {% data variables.product.prodname_copilot_short %} | Least restrictive organization | [AUTOTITLE](/copilot/using-github-copilot/coding-agent/extending-copilot-coding-agent-with-mcp) |

147
content/copilot/responsible-use/copilot-cli.md Normal file
View File

@@ -0,0 +1,147 @@
---
title: Responsible use of GitHub Copilot CLI
shortTitle: Copilot CLI
intro: 'Learn how to use {% data variables.copilot.copilot_cli %} responsibly by understanding its purposes, capabilities, and limitations.'
product: '{% data reusables.gated-features.copilot-cli %}'
versions:
feature: copilot
topics:
- Copilot
- CLI
redirect_from:
- /copilot/github-copilot-in-the-cli/about-github-copilot-in-the-cli
- /copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-copilot-in-the-cli
- /copilot/responsible-use-of-github-copilot-features/copilot-in-the-cli
- /copilot/responsible-use/copilot-in-the-cli
contentType: rai
---
## About {% data variables.copilot.copilot_cli %}
{% data variables.copilot.copilot_cli %} provides a chat-like interface in the terminal that can autonomously create and modify files on your computer and execute commands. You can ask {% data variables.product.prodname_copilot_short %} to perform any action on the files in the active directory.
{% data variables.copilot.copilot_cli %} can generate tailored changes based on your description and configurations, including tasks like bug fixes, implementing incremental new features, prototyping, documentation, and codebase maintenance.
While working on your task, the {% data variables.product.prodname_copilot_short %} agent has access to your local terminal environment where it can make changes to your code, execute automated tests, run linters, and execute commands available in your environment.
The agent has been evaluated across a variety of programming languages, with English as the primary supported language.
The agent works by using a combination of natural language processing and machine learning to understand your task and make changes in a codebase to complete the task. This process can be broken down into a number of steps.
### Input processing
The input prompt from the user is combined with other relevant, contextual information to form a prompt. That prompt is sent to a large language model for processing. Inputs can take the form of plain natural language, code snippets, or references to files in your terminal.
### Language model analysis
The prompt is then passed through a large language model, which is a neural network that has been trained on a large body of data. The language model analyzes the input prompt to help the agent reason on the task and leverage necessary tools.
### Response generation
The language model generates a response based on its analysis of the prompt. This response can take the form of natural language suggestions, code suggestions, file modifications, and command executions.
### Output formatting
The response generated by the agent is formatted and presented to you. {% data variables.copilot.copilot_cli %} uses syntax highlighting, indentation, and other formatting features to add clarity to the generated response.
The agent might also want to execute commands in your local environment and create, edit, or delete files in your file system in order to complete your task.
You may provide feedback to the agent after it returns a response in the interactive chat window. The agent will then resubmit that feedback to the language model for further analysis. Once the agent completes changes based on feedback, the agent will return an additional response.
Copilot is intended to provide you with the most relevant solution for task resolution. However, it may not always provide the answer you are looking for. You are responsible for reviewing and validating responses generated by {% data variables.product.prodname_copilot_short %} to ensure they are accurate and appropriate. For more information, see the section [Improving the results from {% data variables.copilot.copilot_cli %}](#improving-the-results-from-github-copilot-cli), later in this article.
## Use cases for {% data variables.copilot.copilot_cli %}
You can delegate a task to {% data variables.product.prodname_copilot_short %} in a variety of scenarios, including, but not limited to:
* **Codebase maintenance:** Tackling security-related fixes, dependency upgrades, and targeted refactoring.
* **Documentation:** Updating and creating new documentation.
* **Feature development:** Implementing incremental feature requests.
* **Improving test coverage:** Developing additional test suites for quality management.
* **Prototyping new projects:** Greenfielding new concepts.
* **Setting up your environment:** Running commands in your terminal to set up your local environment to work on existing projects
* **Find the right command to perform a task:** {% data variables.product.prodname_copilot_short %} can provide suggestions for commands to perform tasks you're trying to complete.
* **Explain an unfamiliar command:** {% data variables.product.prodname_copilot_short %} can provide a natural language description of a command's functionality and purpose.
## Improving the results from {% data variables.copilot.copilot_cli %}
{% data variables.copilot.copilot_cli %} can support a wide range of tasks. To enhance the responses you receive, and address some of the limitations of the agent, there are various measures that you can adopt.
For more information about limitations, see the section [Limitations of {% data variables.copilot.copilot_cli %}](#limitations-of-github-copilot-cli), later in this article.
### Ensure your tasks are well-scoped
{% data variables.copilot.copilot_cli %} leverages your prompt as key context when generating a pull request. The more clear and well-scoped the prompt you assign to the agent, the better the results you will get. An ideal issue includes:
* A clear description of the problem to be solved or the work required.
* Complete acceptance criteria on what a good solution looks like (for example, should there be unit tests?).
* Hints or pointers on what files need to be changed.
### Customize your experience with additional context
{% data variables.copilot.copilot_cli %} leverages your prompt, comments and the repository’s code as context when generating suggested changes. To enhance {% data variables.product.prodname_copilot_short %}’s performance, consider implementing custom {% data variables.product.prodname_copilot_short %} instructions to help the agent better understand your project and how to build, test and validate its changes. For more information, see "Add custom instructions to your repository" in [AUTOTITLE](/copilot/tutorials/coding-agent/get-the-best-results#adding-custom-instructions-to-your-repository).
### Use {% data variables.copilot.copilot_cli %} as a tool, not a replacement
While {% data variables.copilot.copilot_cli %} can be a powerful tool for generating code and documentation, it is important to use it as a tool, rather than a replacement for human programming. You should always review and verify commands generated by {% data variables.copilot.copilot_cli %} to ensure that it meets your requirements and is free of errors or security concerns.
### Use secure coding and code review practices
Although {% data variables.copilot.copilot_cli %} can generate syntactically correct code, it may not always be secure. You should always follow best practices for secure coding, such as avoiding hard-coded passwords or SQL injection vulnerabilities, as well as following code review best practices, to address the agent’s limitations. You should always take the same precautions as you would with any code you write that uses material you did not independently originate, including precautions to ensure its suitability. These include rigorous testing, IP scanning, and checking for security vulnerabilities.
### Provide feedback
If you encounter any issues or limitations with {% data variables.copilot.copilot_cli %}, we recommend that you provide feedback using the `/feedback` command.
## Security measures for {% data variables.copilot.copilot_cli %}
### Constraining {% data variables.product.prodname_copilot_short %}’s permissions
By default, {% data variables.product.prodname_copilot_short %} only has access to files and folders in, and below, the directory from which {% data variables.copilot.copilot_cli %} was invoked. Ensure you trust the files in this directory. If {% data variables.product.prodname_copilot_short %} wishes to access files outside the current directory, it will ask for permission. Only grant it permission if you trust the contents of that directory.
{% data variables.product.prodname_copilot_short %} will ask for permission before modifying files. Ensure that it is modifying the correct files before granting permission.
{% data variables.product.prodname_copilot_short %} will also ask for permission before executing commands that may be dangerous. Review these commands carefully before giving it permission to run.
For more information about security practices while using {% data variables.copilot.copilot_cli %}, see "Security considerations" in [AUTOTITLE](/copilot/concepts/agents/about-copilot-cli#security-considerations).
## Limitations of {% data variables.copilot.copilot_cli %}
Depending on factors such as your codebase and input data, you may experience different levels of performance when using {% data variables.copilot.copilot_cli %}. The following information is designed to help you understand system limitations and key concepts about performance as they apply to {% data variables.copilot.copilot_cli %}.
### Limited scope
The language model used by {% data variables.copilot.copilot_cli %} has been trained on a large body of code but still has a limited scope and may not be able to handle certain code structures or obscure programming languages. For each language, the quality of suggestions you receive may depend on the volume and diversity of training data for that language.
### Potential biases
The language model used by {% data variables.copilot.copilot_cli %}’s training data and context gathered by the large language model may contain biases and errors that can be perpetuated by the tool. Additionally, {% data variables.copilot.copilot_cli %} may be biased towards certain programming languages or coding styles, which can lead to suboptimal or incomplete suggestions.
### Security risks
{% data variables.copilot.copilot_cli %} generates code and natural language based on the context of an issue or comment within a repository, which can potentially expose sensitive information or vulnerabilities if not used carefully. You should be careful to review all outputs generated by {% data variables.copilot.copilot_cli %} thoroughly prior to merging.
### Inaccurate code
{% data variables.copilot.copilot_cli %} may generate code that appears to be valid but may not actually be semantically or syntactically correct or may not accurately reflect the intent of the developer.
To mitigate the risk of inaccurate code, you should carefully review and test the generated code, particularly when dealing with critical or sensitive applications. You should also ensure that the generated code adheres to best practices and design patterns and fits within the overall architecture and style of the codebase.
### Public code
{% data variables.copilot.copilot_cli %} may generate code that is a match or near match of publicly available code, even if the "Suggestions matching public code" policy is set to "Block." See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/managing-copilot-policies-as-an-individual-subscriber#enabling-or-disabling-suggestions-matching-public-code).
### Legal and regulatory considerations
Users need to evaluate potential specific legal and regulatory obligations when using any AI services and solutions, which may not be appropriate for use in every industry or scenario. Additionally, AI services or solutions are not designed for and may not be used in ways prohibited in applicable terms of service and relevant codes of conduct.
### Risk management and user accountability in command execution
Additional caution is required when asking or allowing {% data variables.copilot.copilot_cli %} to execute a command, particularly regarding the potential destructiveness of some suggested commands. You may encounter commands for file deletion or hard drive formatting, which can cause problems if used incorrectly. While such commands may be necessary in certain scenarios, you need to be careful when accepting and running these commands.
Additionally, you are ultimately responsible for the commands executed by {% data variables.copilot.copilot_cli %}. It is entirely your decision whether to use commands generated by {% data variables.copilot.copilot_cli %}. Despite the presence of fail-safes and safety mechanisms, you must understand that executing commands carries inherent risks. {% data variables.copilot.copilot_cli %} provides a powerful tool set, but you should approach its recommendations with caution and ensure that commands align with your intentions and requirements.
## Further reading
* [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot)
* [{% data variables.product.prodname_copilot %} Trust Center](https://copilot.github.trust.page/)

103
content/copilot/responsible-use/copilot-in-the-cli.md
View File

@@ -1,103 +0,0 @@
---
title: Responsible use of GitHub Copilot in the CLI
shortTitle: Copilot in the CLI
intro: 'Learn how to use {% data variables.copilot.copilot_cli %} responsibly by understanding its purposes, capabilities, and limitations.'
product: '{% data reusables.gated-features.copilot-in-cli %}'
versions:
feature: copilot-in-the-cli
topics:
- Copilot
- CLI
redirect_from:
- /copilot/github-copilot-in-the-cli/about-github-copilot-in-the-cli
- /copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-copilot-in-the-cli
- /copilot/responsible-use-of-github-copilot-features/copilot-in-the-cli
contentType: rai
---
## About {% data variables.copilot.copilot_cli %}
{% data variables.copilot.copilot_cli %} provides a chat-like interface in the terminal that allows you to ask questions about the command line. You can ask {% data variables.product.prodname_copilot %} to provide either command suggestions or explanations of given commands.
The only supported language for {% data variables.copilot.copilot_cli %} is English.
{% data variables.copilot.copilot_cli %} parses your question and provides an answer using a combination of natural language processing and machine learning. This process can be broken down into a number of steps.
### Input processing
The input prompt from the user is pre-processed by {% data variables.copilot.copilot_cli %} and sent to a {% data variables.product.company_short %} service that is connected to a large language model that then generates a response based on the context and prompt. User input can take the form of natural language prompts or questions. It may also include choosing the command type they would like to ask about from a predetermined list, i.e. generic shell command, Git (`git`), or {% data variables.product.prodname_cli %} (`gh`). The system is only intended to respond to command line-related questions. For more information about {% data variables.product.prodname_cli %}, see [AUTOTITLE](/github-cli/github-cli/about-github-cli).
### Language model analysis
The input prompt is then passed through the language model, which is a neural network that has been trained on a large body of text data. The language model analyzes the input prompt to find the command or command explanation most relevant to your query.
### Response generation
The language model generates a response based on its analysis of the input prompt. This response will take the form of a suggested command or an explanation of the command you asked about. If you want to run a suggested command, you need to copy the command and paste it in a separate window or tab in the terminal.
### Output formatting
The response generated by {% data variables.copilot.copilot_cli %} is formatted and presented to you. {% data variables.copilot.copilot_cli_short %} uses syntax highlighting, indentation, and other formatting features to add clarity to the generated response.
{% data variables.copilot.copilot_cli_short %} is intended to provide you with the most relevant answer to your question. However, it may not always provide the answer you are looking for. Users of {% data variables.copilot.copilot_cli %} are responsible for reviewing and validating responses generated by the system to ensure they are accurate and appropriate. {% data variables.copilot.copilot_cli_short %} also provides an optional feedback mechanism to rate suggestions, which helps us improve the tool for the future. For more information, see [Improving {% data variables.copilot.copilot_cli %}](#improving-github-copilot-in-the-cli).
## Use cases for {% data variables.copilot.copilot_cli %}
{% data variables.copilot.copilot_cli %} can help you by providing either command suggestions or explanations of given commands.
### Find the right command to perform a task
{% data variables.copilot.copilot_cli %} aims to suggest commands that help you perform the tasks you’re trying to complete. To help {% data variables.copilot.copilot_cli_short %} provide better suggestions, you can specify the type of command you are looking for (generic, `git`, or `gh`). If the result isn’t quite what you’re looking for, you can keep revising your question until the returned command meets your expectations. Once you’ve generated the perfect command for your task, you can copy it to your clipboard to run it wherever you need, or you can ask {% data variables.copilot.copilot_cli %} to execute the command for you.
### Explain an unfamiliar command
{% data variables.copilot.copilot_cli %} can help explain a command that you asked about by generating a natural language description of the command's functionality and purpose. This can be useful if you want to understand the command's behavior for the specific example provided without having to read or search through the command's documentation. The explanation can include information such as the command's input and output parameters and examples of how it could be used.
By generating explanations, {% data variables.copilot.copilot_cli %} may help you to understand the command better, leading to enhanced learning, improved productivity, and less context switching. However, it's important to note that the generated explanations may not always be accurate or complete, so you'll need to review, and occasionally correct, its output. You remain responsible for ensuring the accuracy and appropriateness of the commands you run in the command line.
## Improving {% data variables.copilot.copilot_cli %}
To enhance the experience and address some of the limitations of {% data variables.copilot.copilot_cli %}, there are various measures that you can adopt. For more information about the limitations, see [Limitations of {% data variables.copilot.copilot_cli %}](#limitations-of-github-copilot-in-the-cli).
### Use {% data variables.copilot.copilot_cli %} as a tool, not a replacement
While {% data variables.copilot.copilot_cli %} can be a powerful tool for enhancing understanding of commands and the command line, it is important to use it as a tool rather than a replacement for human programming. You should always review and verify the command generated by {% data variables.copilot.copilot_cli_short %} to ensure that it meets your requirements and is free of errors or security concerns.
### Provide feedback
If you encounter any issues or limitations with {% data variables.copilot.copilot_cli %}, we recommend that you provide feedback by selecting the "Rate response" option in {% data variables.copilot.copilot_cli %}. This can help the developers to improve the tool and address any concerns or limitations.
## Limitations of {% data variables.copilot.copilot_cli %}
Depending on factors such as your operating system and input data, you may encounter different levels of accuracy when using {% data variables.copilot.copilot_cli %}. The following information is designed to help you understand system limitations and key concepts about performance as they apply to {% data variables.copilot.copilot_cli %}.
### Limited scope
{% data variables.copilot.copilot_cli %} operates within defined boundaries and might struggle with intricate commands, less common ones, or more recently developed tools. The quality of suggestions it provides for each language can be influenced by the availability and diversity of training data. For instance, inquiries about well-documented commands and tools like Git may yield more accurate responses compared to questions about more obscure command line tools.
### Potential biases and errors
{% data variables.copilot.copilot_cli %}'s training data is sourced from existing online sources. It’s important to note that these sources may include biases and errors of the individuals who contributed to the training data. {% data variables.copilot.copilot_cli_short %} may inadvertently perpetuate these biases and errors. Additionally, {% data variables.copilot.copilot_cli %} might perform differently depending on the scripting languages or scripting styles, potentially resulting in suboptimal or incomplete command suggestions or explanations.
### Inaccurate responses
{% data variables.copilot.copilot_cli %} may generate seemingly valid but syntactically or semantically incorrect commands. To avoid issues, always carefully review and verify suggestions, especially for critical or destructive tasks such as deleting content. Ensure generated commands align with best practices and fit your workflow.
### Risk management and user accountability in command execution
Additional caution is required with the addition of the functionality to ask {% data variables.copilot.copilot_cli %} to execute a command, particularly regarding the potential destructiveness of some suggested commands. You may encounter commands for file deletion or hard drive formatting, which can cause problems if used incorrectly. While such commands may be necessary in certain scenarios, you need to be careful when accepting and running these commands.
Additionally, you are ultimately responsible for the commands executed by {% data variables.copilot.copilot_cli %}. It is entirely your decision whether to use commands generated by {% data variables.copilot.copilot_cli %}. Despite the presence of fail-safes and safety mechanisms, you must understand that executing commands carries inherent risks. {% data variables.copilot.copilot_cli %} provides a powerful tool set, but you should approach its recommendations with caution and ensure that commands align with your intentions and requirements.
### Inaccurate responses to non-coding topics
{% data variables.copilot.copilot_cli %} is not designed to answer questions beyond the scope of command line-related tasks. As a result, its responses might not consistently offer accuracy or assistance when confronted with questions unrelated to coding or general command line use. When you inquire about non-coding topics, {% data variables.copilot.copilot_cli %} may express its inability to provide a meaningful response.
### Differing performance based on natural language
{% data variables.copilot.copilot_cli %} has been trained on natural language content written predominantly in English. As a result, you may notice differing performance when providing {% data variables.copilot.copilot_cli %} with natural language input prompts in languages other than English.
## Further reading
* [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot)
* [{% data variables.product.prodname_copilot %} Trust Center](https://copilot.github.trust.page/)

3
content/copilot/responsible-use/index.md
View File

@@ -11,7 +11,7 @@ children:
- /chat-in-your-ide
- /chat-in-github
- /chat-in-github-mobile
- /copilot-in-the-cli
- /copilot-cli
- /copilot-in-windows-terminal
- /copilot-in-github-desktop
- /pull-request-summaries
@@ -25,4 +25,3 @@ redirect_from:
- /copilot/responsible-use-of-github-copilot-features
contentType: rai
---

6
content/get-started/learning-to-code/getting-started-with-git.md
View File

@@ -129,11 +129,7 @@ Before you start working with the command line, you need to set up a few tools.
```
Choose to authenticate with **{% data variables.product.prodname_dotcom_the_website %}**, then follow the on-screen prompts.
1. Install {% data variables.copilot.copilot_cli %}, a powerful extension for the {% data variables.product.prodname_cli %} that helps you find and understand commands, by running the following command:
```shell copy
gh extension install github/gh-copilot
```
1. Install {% data variables.copilot.copilot_cli %}, so that you can use {% data variables.product.prodname_copilot_short %} from the command line. See [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-cli).
### Experimenting with complex commands

3
data/reusables/cli/feedback.md Normal file
View File

@@ -0,0 +1,3 @@
## Feedback
If you have any feedback about {% data variables.copilot.copilot_cli %}, please let us know by using the `/feedback` slash command in an interactive session and choosing one of the options. You can complete a private feedback survey, submit a bug report, or suggest a new feature.

2
data/reusables/cli/preview-note-cli.md Normal file
View File

@@ -0,0 +1,2 @@
> [!NOTE]
> {% data variables.copilot.copilot_cli %} is in public preview and subject to change.

1
data/reusables/cli/tools-needing-approval.md Normal file
View File

@@ -0,0 +1 @@
for example, `touch`, `chmod`, `node`, or `sed`

2
data/reusables/copilot/code-review/custom-instructions-information.md
View File

@@ -2,7 +2,7 @@ You can customize {% data variables.copilot.copilot_code-review_short %} by addi
Repository custom instructions can either be repository wide or path specific. You specify repository-wide custom instructions in a `.github/copilot-instructions.md` file in your repository. You can use this file to store information that you want {% data variables.product.prodname_copilot_short %} to consider when reviewing code anywhere in the repository.
You can also write instructions that {% data variables.product.prodname_copilot_short %} will only use when reviewing code in files that match a specified path. You write these instructions in one or more `.github/instructions/NAME.instructions.md` files.
You can also write instructions that {% data variables.product.prodname_copilot_short %} will only use when reviewing code in files that match a specified path. You write these instructions in one or more `.github/instructions/**/NAME.instructions.md` files.
For more information, see [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot).

2
data/reusables/copilot/quickstart-nextsteps2.md
View File

@@ -1,3 +1,3 @@
* **Use {% data variables.product.prodname_copilot_short %} on your mobile device** - See [AUTOTITLE](/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-github-mobile).
* **Use {% data variables.product.prodname_copilot_short %} on the command line** - See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-the-cli).
* **Use {% data variables.product.prodname_copilot_short %} on the command line** - See [AUTOTITLE](/copilot/concepts/agents/about-copilot-cli).
* **Configure {% data variables.product.prodname_copilot_short %} in your editor** - You can enable or disable {% data variables.product.prodname_copilot %} from within your editor, and create your own preferred keyboard shortcuts for {% data variables.product.prodname_copilot_short %}. See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-your-environment).

2
data/reusables/copilot/repository-custom-instructions-support.md
View File

@@ -17,7 +17,7 @@ The following table shows which {% data variables.product.prodname_copilot_short
{% endrowheaders %}
**1:** Repository-wide instructions (using the `.github/copilot-instructions.md` file) are supported.<br>
**2:** Repository-wide instructions and path-specific instructions (using `.github/instructions/NAME.instructions.md` files) are supported.<br>
**2:** Repository-wide instructions and path-specific instructions (using `.github/instructions/**/NAME.instructions.md` files) are supported.<br>
**3:** Repository-wide instructions, path-specific instructions, and agent instructions (using `AGENTS.md`, `CLAUDE.md` or `GEMINI.md` files) are supported.<br>
**X:** Custom instructions are not supported.<br>
**N/A:** Feature not available on this platform.

3
data/reusables/gated-features/copilot-cli.md Normal file
View File

@@ -0,0 +1,3 @@
{% data variables.copilot.copilot_cli %} is available with the {% data variables.copilot.copilot_pro %}, {% data variables.copilot.copilot_pro_plus %}, {% data variables.copilot.copilot_for_business %} and {% data variables.copilot.copilot_enterprise %} plans.
If you receive {% data variables.product.prodname_copilot_short %} from an organization, the {% data variables.copilot.copilot_cli_short %} policy must be enabled in the organization's settings.

3
data/reusables/gated-features/copilot-in-cli.md
View File

@@ -1,3 +0,0 @@
Owners of organizations or enterprises with a {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} subscription can decide whether to grant access to {% data variables.copilot.copilot_cli %} for users in their organization or enterprise.
<br><br>
If you have a {% data variables.copilot.copilot_pro_short %} or {% data variables.copilot.copilot_pro_plus_short %} subscription, you now have access to {% data variables.copilot.copilot_cli %}.

9
data/variables/copilot.yml
View File

@@ -63,8 +63,10 @@ copilot_chat_dotcom_short: 'Copilot Chat in GitHub'
copilot_chat_dotcom: 'GitHub Copilot Chat in GitHub'
copilot_chat_short: 'Copilot Chat'
copilot_chat: 'GitHub Copilot Chat'
copilot_cli_short: 'Copilot in the CLI'
copilot_cli: 'GitHub Copilot in the CLI'
copilot_cli_short: 'Copilot CLI'
copilot_cli: 'GitHub Copilot CLI'
copilot_old-cli_short: 'Copilot in the CLI'
copilot_old-cli: 'GitHub Copilot in the CLI'
copilot_customization: 'Copilot Customization'
copilot_desktop_short: 'Copilot in GitHub Desktop'
copilot_desktop: 'GitHub Copilot in GitHub Desktop'
@@ -124,6 +126,9 @@ copilot_o4_mini: 'o4-mini'
## xAI:
copilot_grok_code: 'Grok Code Fast 1'
## Current model used by Copilot coding agent and Copilot CLI
cca_current_model: '{% data variables.copilot.copilot_claude_sonnet_40 %}'
## Next edit suggestions in VS Code
next_edit_suggestions: 'next edit suggestions'
next_edit_suggestions_caps: 'Next edit suggestions'