Using GitHub Copilot CLI

Learn how to use GitHub Copilot from the command line.

この機能を使用できるユーザーについて

GitHub Copilot in the CLI is available with the GitHub Copilot Pro, GitHub Copilot Pro+, GitHub Copilot Business and GitHub Copilot Enterprise plans.

If you receive Copilot from an organization, the CLI での Copilot policy must be enabled in the organization's settings.

この記事の内容

The command-line interface (CLI) for GitHub Copilot allows you to use Copilot directly from your terminal. For more information, see About GitHub Copilot CLI.

メモ

GitHub Copilot in the CLI is in public preview and subject to change.

Prerequisite

Install CLI での Copilot. See Installing GitHub Copilot CLI.

Using CLI での Copilot

  1. In your terminal, navigate to a folder that contains code you want to work with.

  2. Enter copilot to start CLI での Copilot.

    Copilot will ask you to confirm that you trust the files in this folder.

    重要

    During this GitHub Copilot in the CLI session, Copilot 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 About GitHub Copilot CLI.

  3. Choose one of the options:

    1. Yes, proceed:

    Copilot 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 CLI での Copilot from this folder. Only choose this option if you are sure that it will always be safe for Copilot to work with files in this location.

    3. No, exit (Esc):

    End your CLI での Copilot session.

  4. If you are not currently logged in to GitHub, you'll be prompted to use the /login slash command. Enter this command and follow the on-screen instructions to authenticate.

  5. Enter a prompt in the CLI.

    This can be a simple chat question, or a request for Copilot 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 About GitHub Copilot CLI.

  6. When Copilot wants to use a tool that could modify or execute files—for example, touch, chmod, node, or sed—it will ask you to approve the use of the tool.

    Choose one of the options:

    1. Yes:

    Allow Copilot to use this tool. The next time Copilot 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 Copilot 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 Copilot 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):

    Copilot will not run the command. Instead, it ends the current operation and awaits your next prompt. You can tell Copilot to continue the task but using a different approach.

    For example, if you ask Copilot to create a bash script but you do not want to use the script Copilot 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 CLI での Copilot with the following tips.

Stop a currently running operation

If you enter a prompt and then decide you want to stop Copilot from completing the task while it is still "Thinking," press Esc.

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 Copilot.

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 Tab to complete the path in your prompt.

Work with files in a different location

To complete a task, Copilot may need to work with files that are outside the current working directory. If a prompt you have entered in an interactive session requires Copilot 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:

/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 CLI での Copilot session by using the slash command:

/cwd /path/to/directory

Resume an interactive session

You can return to a previous interactive session, and continue your conversation with Copilot, 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 Copilot’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 Copilot to better understand the context of your project and how to respond to your prompts.

CLI での Copilot 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 GitHub Copilot のリポジトリ カスタム命令を追加する.

Add an MCP server

CLI での Copilot comes with the GitHub MCP server already configured. This MCP server allows you to interact with resources on GitHub.com—for example, allowing you to merge pull requests from the CLI.

To extend the functionality available to you in CLI での Copilot, you can add more MCP servers:

  1. Use the following slash command:

    /mcp add

  2. Fill in the details for the MCP server you want to add, using the Tab key to move between fields.

  3. Press Ctrl+S 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 モデル コンテキスト プロトコル (MCP) を使用した GitHub Copilot コーディング エージェントの拡張.

Find out more

For a complete list of the command line options and slash commands that you can use with CLI での Copilot, 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 CLI での Copilot:

    copilot help environment

  • Available logging levels:

    copilot help logging

  • Permissions for allowing or denying tool use:

    copilot help permissions

Feedback

If you have any feedback about GitHub Copilot in the 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.