gh-agent-task

gh agent-task subcommand [options]

gh agent-task delegates work to the GitHub Copilot coding agent from the command line. The agent is asynchronous and autonomous: when you create a task it opens a draft pull request, works on the changes in the background, then requests your review when it is done.gh agent-task create starts a session against the current repository, using your prompt as the task description. Because the agent runs remotely, the command returns immediately unless --follow is given, in which case it streams the session log until the agent finishes.gh agent-task list shows running and past sessions, and gh agent-task view inspects one of them, optionally streaming its logs. Both support --json for scripting; available JSON fields include id, name, state, createdAt, completedAt, repository, pullRequestNumber, pullRequestState, pullRequestTitle and pullRequestUrl.The command group can also be invoked as gh agent, gh agents or gh agent-tasks.

-b, --base branch

create: base branch for the pull request. Defaults to the repository's default branch.

create: use a custom agent, e.g. my-agent refers to the my-agent.md agent file.

create: read the task description from a file; use - for standard input.

create, view: follow the agent session logs in real time.

view: show the agent session logs.

Select another repository instead of the current one.

list: maximum number of agent tasks to fetch (default 30).

list, view: output JSON with the specified fields.

list, view: filter JSON output using a jq expression.

list, view: format JSON output using a Go template.

list, view: open agent tasks in the browser.

create [prompt]

Create a new agent task on the current repository. With no prompt, you are asked to enter one interactively.

List your most recent agent tasks.

View details of an agent task, or of the task associated with a pull request.

Requires GitHub CLI 2.80.0 or later and an account with Copilot coding agent access. The command set is a public preview and is subject to change, so flags and output may shift between releases.Tasks consume Copilot premium requests, and the agent pushes commits to a draft pull request on your behalf. Review its changes before merging.

The agent-task command set was added to the GitHub CLI in v2.80.0 and announced in September 2025, bringing Copilot coding agent sessions to the terminal.

gh(1), gh-copilot(1), gh-pr(1), copilot(1)

Source code · Homepage · Documentation