9.0 KiB
title, shortTitle, intro, product, versions, topics, redirect_from, contentType
| title | shortTitle | intro | product | versions | topics | redirect_from | contentType | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Tracking GitHub Copilot's sessions | Track Copilot sessions | You can use the agents panel or page, {% data variables.product.prodname_vscode %}, the {% data variables.product.prodname_cli %}, Raycast and session logs to track {% data variables.product.prodname_copilot_short %}'s progress and understand its approach. | {% data reusables.gated-features.copilot-coding-agent %}<br><a href="https://github.com/features/copilot/plans?ref_product=copilot&ref_type=engagement&ref_style=button" target="_blank" class="btn btn-primary mt-3 mr-3 no-underline"><span>Sign up for {% data variables.product.prodname_copilot_short %}</span> {% octicon "link-external" height:16 %}</a> |
|
|
|
how-tos |
Introduction
After you give {% data variables.product.prodname_copilot_short %} a task, it works autonomously in the background to complete it. See AUTOTITLE.
The agents panel, agents page, the {% data variables.product.prodname_cli %}, and {% data variables.product.prodname_copilot %} extension for Raycast provide an overview of your agent sessions across repositories. You can use them to kick off new tasks and track {% data variables.product.prodname_copilot_short %}'s progress.
You can also track {% data variables.product.prodname_copilot_short %}'s sessions in a specific repository from {% data variables.product.prodname_vscode %}.
During or after an agent session, you can inspect the session logs to understand {% data variables.product.prodname_copilot_short %}'s approach to your problem.
Tracking agent sessions from the agents panel or page
You can see a list of your running and past agent sessions in the agents panel, available from every page on {% data variables.product.github %}, or on the dedicated agents page.
To open the agents panel, click {% octicon "agent" aria-label="The Agents icon" %} in the navigation bar on any page.
To open the agents page, open the agents panel, then click View all.
For each session listed below, you can see its status at a glance, or click on it to navigate to the linked pull request.
To view the session logs, click through to the pull request in the list, then find the "{% data variables.product.prodname_copilot_short %} started work..." event in the timeline, and then click View session.
You can also start new agent sessions from the page and panel. See AUTOTITLE.
Tracking agent sessions from the {% data variables.product.prodname_cli %}
Note
The
agent-taskcommand set is only available in v2.80.0 or later of the {% data variables.product.prodname_cli %}. This command set is a {% data variables.release-phases.public_preview %} and is subject to change.
You can see a list of your running and past agent sessions from the {% data variables.product.prodname_cli %} 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.
Tracking agent sessions from Raycast
{% data reusables.copilot.coding-agent.raycast-intro %}
{% data reusables.copilot.coding-agent.raycast-setup %}
- Open Raycast, search for "{% data variables.product.prodname_copilot_short %}," find the View Tasks command, then press Enter.
- Click Sign in with {% data variables.product.github %}, then complete the authentication flow. Raycast will re-open.
- You'll see a list of your tasks. To navigate to the linked pull request, press Enter. To view the session logs, press Command+L.
Note
If you are unable to see some tasks in Raycast, the organization that owns the repository may have enabled {% data variables.product.prodname_oauth_app %} access restrictions. To learn how to request approval for the "{% data variables.product.prodname_copilot %} for Raycast" {% data variables.product.prodname_oauth_app %}, see AUTOTITLE.
You can also start new agent sessions from Raycast. See AUTOTITLE.
Tracking sessions from {% data variables.product.prodname_vscode %}
You can see a list of your running and past agent sessions for a specific repository in {% data variables.product.prodname_vscode %} with the GitHub Pull Requests extension.
Once you've installed the extension, you can see {% data variables.product.prodname_copilot_short %}'s sessions by clicking the {% data variables.product.github %} button in the sidebar.
For each session listed, you can see its status at a glance, or click on it to navigate to the pull request within {% data variables.product.prodname_vscode %}.
To view the session logs, click on the pull request in the list, then click View Session.
You can also start new agent sessions from {% data variables.product.prodname_vscode %}. See AUTOTITLE.
Tracking sessions from {% data variables.product.prodname_mobile %}
You can see a list of your running and past pull requests generated by agents in {% data variables.product.prodname_mobile %}.
-
In the "Agents" section on the {% data variables.product.prodname_mobile %} Home page, tap Agent Tasks.
A list of the currently open pull requests, that you asked {% data variables.product.prodname_copilot_short %} to generate, is displayed.
-
Use the buttons at the top of the list to filter the list of pull requests.
For example, to show only merged tasks, tap Open and then, in the dropdown, tap Merged.
Using the session logs to understand {% data variables.product.prodname_copilot_short %}'s approach
You can dive into {% data variables.product.prodname_copilot_short %}'s session logs in {% data variables.product.github %} or {% data variables.product.prodname_vscode %} to understand how it approached your task.
In the session logs, you can see {% data variables.product.prodname_copilot_short %}'s internal monologue and the tools it used to understand your repository, make changes and validate its work.
Note
{% data variables.product.prodname_copilot_short %} has its own development environment, including the ability to run automated tests and linters, to validate its changes before it pushes.
Stopping a {% data variables.product.prodname_copilot_short %} session
You can stop {% data variables.product.prodname_copilot_short %} from continuing to work on a task by clicking Stop session in the session log viewer.
Reasons you might want to stop a session include:
- {% data variables.product.prodname_copilot_short %} appears to be going in a wrong direction, and you want to stop it and give it more clarity.
- You made a mistake in your description of the required work, and you've decided to start over.
- You've realized that the change you asked for doesn't need to be made, so you want to stop {% data variables.product.prodname_copilot_short %} from doing any more work on it.