Skip to content

quickstart-copilot-app.md

Latest commit

 

History

History
102 lines (75 loc) · 7.02 KB

quickstart-copilot-app.md

File metadata and controls

102 lines (75 loc) · 7.02 KB
Raw
title Getting started with the GitHub Copilot app
shortTitle Copilot app quickstart
allowTitleToDifferFromFilename true
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.
product {% data reusables.gated-features.github-app %}<br>{% data reusables.copilot.github-app-download-button %}
versions
feature
copilot
contentType get-started
redirect_from
/copilot/how-tos/github-app/getting-started
/copilot/how-tos/github-copilot-app/getting-started
category
Quickstarts
Author and optimize with Copilot

For a conceptual overview of the {% data variables.copilot.github_copilot_app %}, see AUTOTITLE.

In this quickstart, you will:

  1. Install and sign in to the {% data variables.copilot.github_copilot_app %}.
  2. Connect a repository or local folder.
  3. Make code changes in an agent session.

Prerequisites

  • A {% data variables.product.github %} account.
  • A {% data variables.product.prodname_copilot_short %} plan, or you can configure your own model provider.
    • If you use your own model provider, you will need provider credentials such as an API key. For setup steps, see AUTOTITLE.
  • Git installed on your computer.

Note

For {% data variables.copilot.copilot_business_short %} and {% data variables.copilot.copilot_enterprise_short %} users, the {% data variables.copilot.github_copilot_app %} policy must remain enabled. This policy is enabled by default and is separate from the {% data variables.copilot.copilot_cli_short %} policy. See AUTOTITLE or AUTOTITLE.

Installing the {% data variables.copilot.github_copilot_app %}

Download and install the {% data variables.copilot.github_copilot_app %} for your operating system. For other operating systems and architectures, see the download page.

{% data reusables.copilot.github-app-download-button %}

Opening the {% data variables.copilot.github_copilot_app %} for the first time

  1. Open the {% data variables.copilot.github_copilot_app %}.

  2. Click Sign in to {% data variables.product.github %} and follow the prompts to authenticate.

    If you use {% data variables.product.prodname_ghe_cloud %} with data residency, choose Use GitHub Enterprise and enter your *.ghe.com hostname when prompted. {% data variables.product.prodname_ghe_server %} is not supported by the {% data variables.copilot.github_copilot_app %}.

  3. 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.

    • If you choose to use your own model provider, select a provider, enter any required credentials, then click Save and continue.

  4. 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.

  5. Choose a theme, then complete onboarding to open the app.

Connecting a repository or folder

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:

  1. In the sidebar, next to Projects, click {% octicon "plus" aria-label="Add project" %}.
  2. Under Add project from, choose one of the following:
  • Local folder or repository — Select a folder already on your machine, including one that contains a repository you've already cloned locally.
  • {% data variables.product.github %} repository — Browse and clone a repository from {% data variables.product.github %}.
  • 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.

Making your first code changes

  1. Under Projects in the sidebar, find the connected folder or repository you want to use, then click {% octicon "plus" aria-label="Start a new session" %} next to it.

  2. Select a session mode from the dropdown below the prompt field—for example, Interactive to work collaboratively with the agent.

  3. In the prompt box, paste this prompt:

    Suggest a small low-risk code change in this repository, implement it, and explain the diff.

  4. Respond to any requests for input from the agent. After the agent makes changes, click Changes above the prompt box to view the diff.

  5. Continue iterating in the same session until you are happy with the result.

  6. If you want to keep the change, click Create PR to open a pull request for review.

  7. If you create a pull request, click PR above the prompt box to view it directly in the app.

Optional: If you already have tasks you want to complete in your repository, you can start a session from an issue in My work. For more information, see AUTOTITLE.

Orienting yourself

The sidebar gives you access to the main areas of the app:

  • New — Start a new agent session.
  • My work — Browse and filter issues and pull requests from your repositories, check CI status, and leave reviews.
  • Automations — Saved agent tasks that run on a schedule or on demand.
  • Customize — Discover and manage plugins, skills, MCP servers, and canvases.
  • Search — Search across your repositories directly from the app.
  • Projects — View connected projects and their active agent sessions, or start a new session for a project.
  • Chats — General conversations that do not require a dedicated branch or workspace.

Next steps

Find out more about using the {% data variables.copilot.github_copilot_app %}: