|
| 1 | +--- |
| 2 | +title: Get started with {% data variables.product.prodname_copilot_short %} agents on {% data variables.product.github %} |
| 3 | +shortTitle: Get started |
| 4 | +intro: Try {% data variables.copilot.copilot_cloud_agent %} end-to-end in about ten minutes. |
| 5 | +product: '{% data reusables.gated-features.copilot-cloud-agent %}<br><a href="https://github.com/features/copilot/plans?ref_product=copilot&ref_type=purchase&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>' |
| 6 | +allowTitleToDifferFromFilename: true |
| 7 | +versions: |
| 8 | + feature: copilot |
| 9 | +contentType: how-tos |
| 10 | +--- |
| 11 | + |
| 12 | +## Prerequisite |
| 13 | + |
| 14 | +You need a repository where {% data variables.copilot.copilot_cloud_agent %} is enabled. For {% data variables.copilot.copilot_business_short %} and {% data variables.copilot.copilot_enterprise_short %} subscribers, an administrator must enable the agent before you can use it. See [AUTOTITLE](/copilot/concepts/agents/cloud-agent/access-management). |
| 15 | + |
| 16 | +## Step 1: Assign an issue to {% data variables.product.prodname_copilot_short %} |
| 17 | + |
| 18 | +Pick a repository where {% data variables.copilot.copilot_cloud_agent %} is enabled and find an open issue—or create a small one, such as "Add a CONTRIBUTING.md file." |
| 19 | + |
| 20 | +1. In the right sidebar, click **Assignees**, then select **Copilot**. |
| 21 | +1. Optionally, add instructions in the **Optional prompt** field. |
| 22 | + |
| 23 | + For example: `Keep the file short and include a code of conduct section.` |
| 24 | +1. Click **Assign**. |
| 25 | + |
| 26 | +{% data variables.product.prodname_copilot_short %} starts a session and begins working on a pull request. |
| 27 | + |
| 28 | +## Step 2: Start a research task at the same time |
| 29 | + |
| 30 | +While {% data variables.product.prodname_copilot_short %} works on the issue, start a second, non-coding task to see two sessions running in parallel. |
| 31 | + |
| 32 | +1. In the same repository, click the **{% octicon "agent" aria-hidden="true" aria-label="agent" %} Agents** tab. |
| 33 | +1. Type a research prompt. |
| 34 | + |
| 35 | + For example: `Investigate which dependencies in this repo are outdated and summarize what upgrading would involve.` |
| 36 | +1. Click **{% octicon "paper-airplane" aria-label="Start task" %}** or press <kbd>Enter</kbd>. |
| 37 | + |
| 38 | +A second session appears in the panel alongside the first. |
| 39 | + |
| 40 | +## Step 3: Watch both sessions |
| 41 | + |
| 42 | +Both sessions update in real time. Click either session to view the agent's reasoning, the files it reads, and the changes it makes. |
| 43 | + |
| 44 | +While a session is running, type in the prompt box below the log to steer the agent. |
| 45 | + |
| 46 | +For example: `Focus on security-related dependencies first.` |
| 47 | + |
| 48 | +For more details on monitoring, steering, and stopping sessions, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/use-copilot-agents/manage-and-track-agents). |
| 49 | + |
| 50 | +## Step 4: Request a {% data variables.copilot.copilot_code-review_short %} on the pull request |
| 51 | + |
| 52 | +When the coding task finishes, {% data variables.product.prodname_copilot_short %} opens a pull request and adds you as a reviewer. |
| 53 | + |
| 54 | +1. Open the pull request from the notification or from the session log. |
| 55 | +1. In the right sidebar, click **Reviewers**, then select **{% data variables.product.prodname_copilot_short %}**. |
| 56 | +1. Wait for {% data variables.copilot.copilot_code-review_short %} to leave comments—usually under 30 seconds. |
| 57 | + |
| 58 | +Read through the review comments. {% data variables.product.prodname_copilot_short %} may suggest changes you can apply directly with a click. |
| 59 | + |
| 60 | +For the full set of code-review options, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/use-copilot-agents/copilot-code-review). |
| 61 | + |
| 62 | +## Step 5: Review the output and iterate |
| 63 | + |
| 64 | +Now review the code changes yourself, just as you would for any contributor's pull request. |
| 65 | + |
| 66 | +* **Request changes from {% data variables.product.prodname_copilot_short %}** — mention `@copilot` in a comment describing what to fix. {% data variables.product.prodname_copilot_short %} pushes new commits to the same branch. |
| 67 | +* **Make changes yourself** — check out the branch and push your own commits. |
| 68 | +* **Approve and merge** — when you're satisfied, merge the pull request. |
| 69 | + |
| 70 | +For more on reviewing {% data variables.product.prodname_copilot_short %}'s work, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/use-copilot-agents/review-copilot-output). |
| 71 | + |
| 72 | +## Next steps |
| 73 | + |
| 74 | +* [AUTOTITLE](/copilot/tutorials/cloud-agent/get-the-best-results) — Write effective prompts and get the most out of agents. |
0 commit comments