Skip to main content

Using Copilot cloud agent from the GitHub CLI

Start and track Copilot云代理 sessions from the GitHub CLI.

谁可以使用此功能?

Copilot云代理可用于GitHub Copilot Pro、GitHub Copilot Pro+、GitHub Copilot业务和GitHub Copilot Enterprise计划。 代理在所有存储于GitHub的存储库中可用,除非这些存储库由托管用户帐户拥有或已被显式禁用。
Sign up for Copilot

在本文中

注意

The agent-task command set is only available in v2.80.0 or later of the GitHub CLI. This command set is a 公开预览 and is subject to change.

Starting a session

You can start a new Copilot云代理 session with the gh agent-task create command.

When you run the command without any arguments, you are asked to enter a prompt. Copilot云代理 acts on the prompt and opens a pull request in the current repository.

You can use command line options to:

  • Provide the prompt (gh agent-task create "Example prompt")
  • Choose a base branch, instead of using the repository's default branch (--base)
  • Select a repository, instead of targeting the current repository (--repo)
  • Follow the session log in real time (--follow)

To see all of the available options, run gh agent-task create --help.

Tracking your sessions

You can see a list of your running and past agent sessions with the gh agent-task list command. The output will show a list of your recent sessions.

To see more information on a specific session, use the gh agent-task view command. For example, to view information about the session associated with pull request #123 in the monalisa/bookstore repository, run gh agent-task view --repo monalisa/bookstore 123.

To view the session logs, add the --log option. Optionally, use the --follow option to stream live logs as the agent works.

To see all of the available options, run gh agent-task list --help or gh agent-task view --help.

Further reading