getting-started-with-github-desktop.md

title	intro	versions	redirect_from	shortTitle
Getting started with GitHub Desktop	Learn how to set up, authenticate, and configure {% data variables.product.prodname_desktop %} to allow you to contribute to projects directly from your machine.	fpt ghec ghes * * *	/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop /desktop/guides/getting-started	Get started

Introduction

{% data reusables.desktop.about-github-desktop %}

This guide will help you get started with {% data variables.product.prodname_desktop %} by setting up the application, authenticating your account, configuring basic settings, and introducing the fundamentals of managing projects with {% data variables.product.prodname_desktop %}. You will be able to use {% data variables.product.prodname_desktop %} to collaborate on projects and connect to remote repositories after working through this guide.

You might find it helpful to have a basic understanding of Git and {% data variables.product.prodname_dotcom %} before getting started with {% data variables.product.prodname_desktop %}. For more information, see the following articles.

• AUTOTITLE
• AUTOTITLE
• AUTOTITLE

{% data variables.product.prodname_desktop %} is an open source project. You can see the roadmap, contribute to the project, or open an issue to provide feedback or feature requests. For more information, see the desktop/desktop repository.

Part 1: Installing and authenticating

You can install {% data variables.product.prodname_desktop %} on any supported operating system. For more information, see AUTOTITLE.

To install {% data variables.product.prodname_desktop %}, visit the download page for {% data variables.product.prodname_desktop %}. For more information, see AUTOTITLE.

After you have installed {% data variables.product.prodname_desktop %}, you can authenticate the application with your account on {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}. Authenticating allows you to connect to remote repositories on {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}.

{% mac %}

1. Before you can authenticate to {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, you will need an account.{% ifversion fpt or ghec %} For more information, see AUTOTITLE.{% endif %}{% ifversion ghec %} If you're part of an organization that uses {% data variables.product.prodname_emus %} and you do not have an account, contact your enterprise administrator.{% elsif ghes %} If you're a member of an organization that uses {% data variables.product.prodname_ghe_server %} and you do not have an account, contact your site administrator.{% endif %} {% data reusables.desktop.mac-select-desktop-menu %} {% data reusables.desktop.mac-click-sign-into %}
2. Follow the steps to sign in. For more information about authentication, see AUTOTITLE.

{% endmac %}

{% windows %}

1. Before you can authenticate to {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, you will need an account.{% ifversion fpt or ghec %} For more information, see AUTOTITLE.{% endif %}{% ifversion ghec %} If you're part of an organization that uses {% data variables.product.prodname_emus %} and you do not have an account, contact your enterprise administrator.{% elsif ghes %} If you're a member of an organization that uses {% data variables.product.prodname_ghe_server %} and you do not have an account, contact your site administrator.{% endif %} {% data reusables.desktop.windows-choose-options %} {% data reusables.desktop.windows-click-sign-into %}
2. Follow the steps to sign in. For more information about authentication, see AUTOTITLE.

{% endwindows %}

Part 2: Configuring and customizing {% data variables.product.prodname_desktop %}

After you install {% data variables.product.prodname_desktop %}, you can configure and customize the app to best suit your needs.

{% mac %}

You can connect or remove accounts on {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, choose a default text editor or shell, edit your Git configuration, change the appearance of {% data variables.product.prodname_desktop %}, customize system dialog boxes, and set privacy preferences in the {% data variables.product.prodname_desktop %} Settings window. For more information, see AUTOTITLE.

{% endmac %}

{% windows %}

You can connect or remove accounts on {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, choose a default text editor or shell, edit your Git configuration, change the appearance of {% data variables.product.prodname_desktop %}, customize system dialog boxes, and set privacy preferences in the {% data variables.product.prodname_desktop %} Options window. For more information, see AUTOTITLE.

{% endwindows %}

Part 3: Contributing to projects with {% data variables.product.prodname_desktop %}

After installing, authenticating, and configuring the app, you are ready to start using {% data variables.product.prodname_desktop %}. You can create, add, or clone repositories and use {% data variables.product.prodname_desktop %} to manage contributions to your repositories.

Creating, adding, and cloning repositories

You can create a new repository by selecting File in the "{% data variables.product.prodname_desktop %}" menu bar and clicking New repository.... For more information, see AUTOTITLE.

You can add a repository from your local computer by selecting File and clicking Add Local Repository.... For more information, see AUTOTITLE.

You can clone a repository from {% data variables.product.prodname_dotcom %} by selecting File and clicking Clone Repository.... For more information, see AUTOTITLE.

{% mac %}

{% endmac %}

{% windows %}

{% endwindows %}

Making changes in a branch

You can use {% data variables.product.prodname_desktop %} to create a branch of a project. Branches isolate your development work from other branches in the repository, so that you can safely experiment with changes. For more information, see AUTOTITLE.

After you make changes to a branch, you can review them in {% data variables.product.prodname_desktop %} and make a commit to keep track of your changes. For more information, see AUTOTITLE.

If you want to access your changes remotely or share them with other people, you can push your commits to {% data variables.product.prodname_dotcom %}. For more information, see AUTOTITLE.

Collaborating with {% data variables.product.prodname_desktop %}

You can use {% data variables.product.prodname_desktop %} to create issues or pull requests to collaborate on projects with other people. Issues help you keep track of ideas and discuss possible changes to projects. Pull requests let you share your proposed changes with others, receive feedback, and merge changes into a project. For more information, see AUTOTITLE.

You can view your own or your collaborator's pull requests in {% data variables.product.prodname_desktop %}. Viewing a pull request in {% data variables.product.prodname_desktop %} lets you see any proposed changes and make additional changes by opening the project's files and repositories in your default text editor. For more information, see AUTOTITLE.

Keeping your local repository in sync

When you make changes to your local repositories or when other people make changes to the remote repositories, you will need to sync your local copy of the project with the remote repository. {% data variables.product.prodname_desktop %} can keep your local copy of a project in sync with the remote version by pushing and pulling commits. For more information, see AUTOTITLE.