You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/copilot/how-tos/github-copilot-app/agent-sessions.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ category:
18
18
Each session in the {% data variables.copilot.github_copilot_app %} runs in its own isolated workspace, so you can run multiple sessions in parallel and make progress on several tasks without conflicts.
19
19
20
20
1. In the sidebar next to **Sessions**, click **+** to start a new session.
21
-
1. Choose a repository—you can use a local folder, choose from {% data variables.product.github %}, or clone from a URL.
21
+
1. Choose a project—you can use a folder already on your machine, choose from {% data variables.product.github %}, or clone from a Git URL for repositories hosted outside {% data variables.product.github %} (for example, on Azure DevOps) or for private repositories without app access.
22
22
1. From the dropdown under the prompt box, choose where the session should run: in a new working tree, in your local repository, or in a cloud sandbox. Cloud sandboxes for {% data variables.product.prodname_copilot_short %} (public preview) are fully isolated environments hosted by {% data variables.product.github %}.
23
23
1. Select a session mode, model, and reasoning effort from the dropdowns below the prompt field. If you choose **Auto** for the model, the app selects the optimal model for your task based on task complexity.
24
24
1. Describe the task in the prompt field. You can reference issues with `#`, add files with `@`, or use `/` for commands.
Copy file name to clipboardExpand all lines: content/copilot/how-tos/github-copilot-app/getting-started.md
+37-40Lines changed: 37 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
title: Getting started with the GitHub Copilot app
3
3
shortTitle: Quickstart
4
4
allowTitleToDifferFromFilename: true
5
-
intro: 'Sign in to the {% data variables.copilot.github_copilot_app %}, ask your first question in a quick chat, and then create a full agent session to make changes to your code.'
5
+
intro: 'Sign in to the {% data variables.copilot.github_copilot_app %}, connect a repository or local folder, and create your first agent session to make code changes.'
For a conceptual overview of the {% data variables.copilot.github_copilot_app %}, see [AUTOTITLE](/copilot/concepts/agents/github-copilot-app).
18
18
19
+
In this quickstart, you will:
20
+
21
+
1. Install and sign in to the {% data variables.copilot.github_copilot_app %}.
22
+
1. Connect a repository or local folder.
23
+
1. Make code changes in an agent session.
24
+
19
25
## Prerequisites
20
26
21
-
*[Git](https://github.com/git-guides/install-git) installed on your computer.
22
27
* A {% data variables.product.github %} account.
23
-
* A {% data variables.product.prodname_copilot_short %} plan. Alternatively, if using your own model provider, you will need required credentials such as an API key. For more information, see [AUTOTITLE](/copilot/how-tos/github-copilot-app/use-byok-models).
24
-
* If you use {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %}, your plan administrator must enable the **{% data variables.copilot.copilot_cli_short %}** policy. See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies) or [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies).
28
+
* Access to {% data variables.product.prodname_copilot_short %} or a configured model provider.
29
+
* If you use your own model provider, you will need provider credentials such as an API key. For setup steps, see [AUTOTITLE](/copilot/how-tos/github-copilot-app/use-byok-models).
30
+
*[Git](https://github.com/git-guides/install-git) installed on your computer.
31
+
32
+
> [!NOTE]
33
+
> If you use {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %}, your plan administrator will need to enable the **{% data variables.copilot.copilot_cli_short %}** policy. For more information, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies) or [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies).
25
34
26
35
## Installing the {% data variables.copilot.github_copilot_app %}
27
36
@@ -34,56 +43,44 @@ For a conceptual overview of the {% data variables.copilot.github_copilot_app %}
34
43
1. Click **Sign in to {% data variables.product.github %}** and follow the prompts to authenticate. If you use {% data variables.product.prodname_ghe_server %}, choose **Use GitHub Enterprise** and enter your server address when prompted.
35
44
1. If you do not have a {% data variables.product.prodname_copilot_short %} plan, choose whether to sign up for a plan or continue with your own model provider.
36
45
* If you choose to use your own model provider, select a provider, enter any required credentials, then click **Save and continue**.
37
-
1. When prompted, select one or more repositories based on your recent {% data variables.product.github %} activity. You can also add a local repository, or skip this step and add repositories later.
46
+
1. When prompted, select one or more repositories based on your recent {% data variables.product.github %} activity. You can also add a local folder or repository, or skip this step and add projects later.
38
47
1. Choose a theme, then complete onboarding to open the app.
39
48
40
-
## Connecting a repository
49
+
## Connecting a repository or folder
41
50
42
-
To work on code, you need at least one repository connected to the app. If you skipped repository setup during onboarding, or want to add more repositories later:
51
+
To work on code, you need at least one project connected to the app. A project can be a folder already on your machine, including a repository you've already cloned locally, or a repository you clone from {% data variables.product.github %} or another remote Git host such as Azure DevOps. Connecting a project unlocks the core app workflow: reading code, making edits, and opening pull requests from agent sessions. If you skipped project setup during onboarding, or want to add more projects later:
43
52
44
53
1. Click the **+** button in the sidebar next to "Sessions".
45
54
1. Under **Add project from**, choose one of the following:
46
-
***Local folder or repository** — Select a folder already on your machine.
47
-
***{% data variables.product.github %} repository** — Browse and clone a repository from {% data variables.product.github %}.
48
-
***Repository URL** — Clone from any Git URL.
49
-
50
-
## Orienting yourself
51
-
52
-
The sidebar gives you access to the main areas of the app:
53
-
54
-
***[My work](https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fmywork)** — Browse and filter issues and pull requests from your repositories, check CI status, and leave reviews.
55
-
***[Automations](https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fautomations)** — Saved agent tasks that run on a schedule or on demand.
56
-
***Search** — Search across your repositories directly from the app.
57
-
***Sessions** — Active agent sessions, grouped by repository. This also includes **Quick chats**, which are general chat conversations.
58
-
59
-
## Starting a quick chat
55
+
***Local folder or repository** — Select a folder already on your machine, including one that contains a repository you've already cloned locally.
56
+
***{% data variables.product.github %} repository** — Browse and clone a repository from {% data variables.product.github %}.
57
+
***Repository URL** — Clone from a Git URL for repositories hosted outside {% data variables.product.github %} (for example, on Azure DevOps) or for private repositories without app access.
60
58
61
-
The fastest way to try the {% data variables.copilot.github_copilot_app %} is with a quick chat. Quick chats let you ask questions and brainstorm without creating a branch or worktree.
59
+
## Making your first code changes
62
60
63
-
1. In the sidebar, click **+** next to "Quick chats" to open a new chat.
64
-
1. Type a question or prompt—for example, "Give me an overview of the octocat repository."
65
-
1. The agent responds in the conversation view. You can continue the conversation, ask follow-up questions, or start a new chat.
66
-
67
-
## Creating your first session
61
+
1. Click **+** next to **Sessions**, then choose a connected folder or repository under **Start session in**.
62
+
1. Select a session mode from the dropdown below the prompt field—for example, **Interactive** to work collaboratively with the agent.
63
+
1. In the prompt box, paste this prompt:
68
64
69
-
When you are ready to make changes to code, create a session. You can start from an issue or describe a task directly.
65
+
```copilot copy
66
+
Suggest a small low-risk code change in this repository, implement it, and explain the diff.
67
+
```
70
68
71
-
### Starting from an issue
69
+
1. Respond to any requests for input from the agent. After the agent makes changes, click **Changes** above the prompt box to view the diff.
70
+
1. Continue iterating in the same session until you are happy with the result.
71
+
1. If you want to keep the change, click **Create PR** to open a pull request for review.
72
+
1. If you create a pull request, click **PR** above the prompt box to view it directly in the app.
72
73
73
-
1. Click **[My work](https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fmywork)** in the sidebar.
74
-
1. Browse or filter to find an issue, then click it to view its details.
75
-
1. Click **New session**. The app creates a new session with the issue context already loaded.
76
-
1. Select a session mode from the dropdown below the prompt field—for example, **Plan** to have the agent propose a plan first, or **Interactive** to work collaboratively with the agent.
77
-
1. Prompt the agent with what you want it to do. If you chose **Plan** mode, the agent proposes a plan for you to review first; otherwise, the agent will start working on the issue and propose changes that you can iterate on. Follow along in the conversation view and provide feedback to steer the agent.
74
+
**Optional:** If you already have tasks you want to complete in your repository, you can start a session from an issue in **[My work](https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fmywork)**. For more information, see [AUTOTITLE](/copilot/how-tos/github-copilot-app/managing-issues-and-pull-requests).
78
75
79
-
### Starting from a task
76
+
##Orienting yourself
80
77
81
-
If you do not have an issue to work from, you can describe a task directly.
78
+
The sidebar gives you access to the main areas of the app:
82
79
83
-
1. In the sidebar, click **+**next to "Sessions" to start a new session, then select a repository.
84
-
1. Select a session mode from the dropdown below the prompt field—for example, **Interactive** to work collaboratively with the agent.
85
-
1. Describe a task—for example, "Fix the failing test in `utils.test.ts`" or "Add input validation to the signup form."
86
-
1. The agent will make changes based on your direction. Follow along in the conversation view and provide feedback to steer the agent.
80
+
***[My work](https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fmywork)**— Browse and filter issues and pull requests from your repositories, check CI status, and leave reviews.
81
+
***[Automations](https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fautomations)** — Saved agent tasks that run on a schedule or on demand.
82
+
***Search** — Search across your repositories directly from the app.
83
+
***Sessions** — Active agent sessions, grouped by project. This also includes **Quick chats**, which are general chat conversations.
0 commit comments