Skip to main content

This version of GitHub Enterprise Server was discontinued on 2024-09-24. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise Server. For help with the upgrade, contact GitHub Enterprise support.

Connecting to GitHub

Learn about the tools you can use to work with repositories hosted on GitHub.

Introduction

GitHub is a web-based app that lets you host files in repositories, collaborate on work, and track changes to files over time. Version tracking on GitHub is powered by the open source software Git. Whenever you update a repository on GitHub, Git tracks the changes you make.

There are many ways to work with GitHub, and you can choose a method that suits your level of experience, personal preferences, and the repositories you work with. For example, you can choose whether you want to work in the browser or from your desktop, how you want to use Git, and what capabilities you need from your editor and other software. You may choose to work with different repositories in different ways.

If you're new to GitHub, a good way to start contributing is to make changes in the browser on your GitHub Enterprise Server instance. As you become more familiar with GitHub and start contributing larger changes, you may want to start working with other tools. This article explains how to progress through these stages and helps you choose the best tool for your requirements at each stage. To quickly compare all the tools available for working with GitHub, see "Comparison of tools for connecting to GitHub."

Getting started

In the user interface on your GitHub Enterprise Server instance, you can perform the whole "GitHub flow" for contributing to a repository, including creating a branch or fork, editing and previewing files, committing your changes, and creating a pull request. You can also upload files from your computer or download them from the repository. For more information, see "GitHub flow."

Working directly on your GitHub Enterprise Server instance is often the quickest way to contribute to a repository, for the following reasons.

  • You're working directly with the repository hosted on GitHub, so you don't have to download a copy of the repository to your computer and keep this copy in sync.
  • If you're already signed in to GitHub, you have access to any repository where you have the necessary permissions, so you don't need to set up any additional authentication on your computer.
  • You can commit changes in the user interface, so you don't need to use the command line or memorize any Git commands.

For a tutorial to help you get started with making changes in the browser, see "Hello World."

Working directly in the browser is best for small, simple changes, often targeting a single file in a repository. If you want to make more complex changes, you may need to connect to GitHub from the desktop, and work with a local copy of the repository.

Working from the desktop

To work with a repository from your desktop, you'll need to download (or "clone") a copy of the repository to your computer, then push any changes you make to GitHub. Working from your desktop can have several advantages over working in the browser.

  • You can work with all your local files and tools.
  • You have access to compute power. For example, you might need to run a script to create a local preview of a site, so you can test the changes you're making.
  • You don't need an Internet connection to work on a project.

If you haven't worked with a GitHub repository from your desktop before, you'll need to authenticate to GitHub from your computer, so you can access the repositories you need. You may also need to set up your working environment with the tools you need to contribute, such as Git, an editor, and dependencies for a project. For these reasons, it can take longer to get started if you want to work from your desktop, compared to working in the browser.

There are several tools you can use to connect to GitHub from your desktop. These tools allow you to authenticate to GitHub, clone a repository, track your changes, and push the changes to GitHub.

  • If you want a lot of control and flexibility, you can use the command line. You'll need to install Git and be familiar with some basic Git commands. You can also install GitHub CLI, a command-line interface that lets you perform many actions on GitHub, such as creating a pull request or forking a repository. For more information, see "Set up Git" and "About GitHub CLI."
  • If you'd prefer to use a visual interface, you can use a visual Git client such as GitHub Desktop. With GitHub Desktop, you can visualize the changes you're making and access most Git commands through a visual interface, so you don't need to memorize any commands. For more information, see "About GitHub Desktop."
  • If you want to work in one place, you can often do most things from your editor. An editor such as VS Code includes an integrated terminal and buttons for common Git commands, so you can edit files and push your changes to GitHub all from one place. You can also install an extension to work directly with pull requests and issues on GitHub. To get started, see Download VS Code.

Comparison of tools for connecting to GitHub

The following table provides a comparison between the tools you can use to work with repositories on GitHub, both in your browser and from your desktop.

You can perform the whole GitHub flow with any of the tools described here. Each tool includes access not only to Git commands for tracking the changes you've made, but also to GitHub-specific features, so you can create a pull request with your proposed changes from wherever you're working.

For more information about how to authenticate to GitHub Enterprise Server with each of these tools, see "About authentication to GitHub."

ToolUse caseBrowser or desktop
On your GitHub Enterprise Server instanceYou want a visual interface and need to make quick, simple changes, typically involving a single commit. For an introduction, see "Hello World."Browser
GitHub DesktopYou want to work with files locally, and would prefer a visual interface to use Git, visualize changes, and interact with GitHub Enterprise Server. For more information, see "About GitHub Desktop."Desktop
IDE or text editorYou're working with more complex files and projects and want everything in one place.Desktop
Command-line Git and GitHub CLIYou're used to working from the command line and want to avoid switching context, or you need to access a complex Git command that isn't integrated into visual interfaces. For more information, see "Set up Git" and "About GitHub CLI."Desktop
GitHub Enterprise Server APIYou want to automate common tasks such as backing up your data, or create integrations that extend GitHub. For more information, see "Comparing GitHub's REST API and GraphQL API."Browser or desktop

Further reading