Repository files navigation

GitHub Desktop is an open-sourceElectron-basedGitHub app. It is written inTypeScript andusesReact.

Download the official installer for your operating system:

• macOS
• macOS (Apple silicon)
• Windows
• Windows machine-wide install

Linux is not officially supported; however, you can find installers created for Linux from a fork of GitHub Desktop in theCommunity Releases section.

Want to test out new features and get fixes before everyone else? Install thebeta channel to get access to early builds of Desktop:

• macOS
• macOS (Apple silicon)
• Windows
• Windows (ARM64)

The release notes for the latest beta versions are availablehere.

You can find past releases athttps://desktop.githubusercontent.com. After installation of a past version, the auto update functionality will attempt to download the latest version.

There are several community-supported package managers that can be used toinstall GitHub Desktop:

• Windows users can install usingwingetc:\> winget install github-desktop orChocolateyc:\> choco install github-desktop
• macOS users can install usingHomebrew package manager:$ brew install --cask github

Installers for various Linux distributions can be found on theshiftkey/desktop fork.

This document describes the focus of GitHub Desktop and who the product is most useful for.

Note: TheGitHub Desktop Code of Conduct applies in all interactions relating to the GitHub Desktop project.

First, please search theopen issuesandclosed issuesto see if your issue hasn't already been reported (it may also be fixed).

There is also a list ofknown issuesthat are being tracked against Desktop, and some of these issues have workarounds.

If you can't find an issue that matches what you're seeing, open anew issue,choose the right template and provide us with enough information to investigatefurther.

If nobody has responded to your issue in a few days, you're welcome to respond to it with a friendly ping in the issue. Please do not respond more than a second time if nobody has responded. The GitHub Desktop maintainers are constrained in time and resources, and diagnosing individual configurations can be difficult and time consuming. While we'll try to at least get you pointed in the right direction, we can't guarantee we'll be able to dig too deeply into any one person's issue.

TheCONTRIBUTING.md document will help you get setup andfamiliar with the source. Thedocumentation folder also contains moreresources relevant to the project.

If you're looking for something to work on, check out thehelp wanted label.

To setup your development environment for building Desktop, check out:setup.md.

Seedesktop.github.com for more product-orientedinformation about GitHub Desktop.

See ourgetting started documentation for more information on how to set up, authenticate, and configure GitHub Desktop.

MIT

The MIT license grant is not for GitHub's trademarks, which include the logodesigns. GitHub reserves all trademark and copyright rights in and to allGitHub trademarks. GitHub's logos include, for instance, the stylizedInvertocat designs that include "logo" in the file title in the followingfolder:logos.

GitHub® and its stylized versions and the Invertocat mark are GitHub'sTrademarks or registered Trademarks. When using GitHub's logos, be sure tofollow the GitHublogo guidelines.