Skip to content

Latest commit

 

History

History
55 lines (38 loc) · 3.27 KB

using-github-copilot-in-the-command-line.md

File metadata and controls

55 lines (38 loc) · 3.27 KB
title intro versions topics product shortTitle redirect_from
Using GitHub Copilot in the command line
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.
feature
copilot-in-the-cli
Copilot
CLI
{% data reusables.gated-features.copilot-free-availability %}
Use Copilot in the CLI
/copilot/github-copilot-in-the-cli/using-github-copilot-in-the-cli
/copilot/using-github-copilot/using-github-copilot-in-the-cli

Prerequisites

  • Access to {% data variables.product.prodname_copilot %}. See AUTOTITLE.
  • {% data variables.product.prodname_cli %} installed. {% data reusables.cli.cli-installation %}
  • {% data variables.product.prodname_copilot_cli_short %} extension installed. See AUTOTITLE.

If you have access to {% data variables.product.prodname_copilot %} via your organization or enterprise, you cannot use {% data variables.product.prodname_copilot_cli_short %} if your organization owner or enterprise administrator has disabled {% data variables.product.prodname_copilot_cli_short %}. See AUTOTITLE.

Getting command explanations

To ask {% data variables.product.prodname_copilot_cli_short %} to explain a command, run gh copilot explain followed by the command that you want explained. For example:

gh copilot explain "sudo apt-get"

Getting command suggestions

To ask {% data variables.product.prodname_copilot_cli_short %} to suggest a command, run gh copilot suggest followed by the command that you want. For example:

gh copilot suggest "Undo the last commit"

{% data variables.product.prodname_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.product.prodname_copilot_cli_short %} suggests a command, {% data variables.product.prodname_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.product.prodname_copilot_cli_short %} to be able to execute commands on your behalf, you must set up the ghcs alias. See AUTOTITLE.

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.product.prodname_copilot_cli_short %}.

You can also open an issue in the {% data variables.product.prodname_copilot_cli_short %} extension repository.

Further reading