| title | intro | versions | topics | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Connecting to GitHub |
Learn about the tools you can use to work with repositories hosted on {% data variables.product.prodname_dotcom %}. |
|
|
{% data variables.product.prodname_dotcom %} 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 {% data variables.product.prodname_dotcom %} is powered by the open source software Git. Whenever you update a repository on {% data variables.product.prodname_dotcom %}, Git tracks the changes you make.
There are many ways to work with {% data variables.product.prodname_dotcom %}, 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 {% data variables.product.prodname_dotcom %}, a good way to start contributing is to make changes in the browser on {% data variables.location.product_location %}. As you become more familiar with {% data variables.product.prodname_dotcom %} 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 {% data variables.product.prodname_dotcom %}, see Comparison of tools for connecting to {% data variables.product.prodname_dotcom %}.
In the user interface on {% data variables.location.product_location %}, you can perform the whole "{% data variables.product.prodname_dotcom %} 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 AUTOTITLE.
Working directly on {% data variables.location.product_location %} is often the quickest way to contribute to a repository, for the following reasons.
- You're working directly with the repository hosted on {% data variables.product.prodname_dotcom %}, 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 {% data variables.product.prodname_dotcom %}, 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 AUTOTITLE.
{% ifversion fpt or ghec %}
Working directly on {% data variables.location.product_location %} is best for small, simple changes, often targeting a single file in a repository. If you want to work in the browser but need to make more complex changes, such as moving content between files, you can choose from the following tools to open a repository in a dedicated editor.
- If you want an editor where you can quickly open or create files, you can press the
.key in any repository to open the github.dev editor. This is a lightweight web-based editor that includes many of the features of {% data variables.product.prodname_vscode %}, such as a search bar and buttons for Git commands. For more information, see AUTOTITLE. - If you want to stay in the browser but need to do things like run commands, create a test build of your project, or install dependencies, you can open a repository in a codespace. A codespace is a remote development environment with storage and compute power. It includes an editor and integrated terminal, and comes preinstalled with common tools you may need to work with a project, including Git. For more information, see AUTOTITLE.
Alternatively, you can connect to {% data variables.product.prodname_dotcom %} from your desktop, and work with a local copy of the repository.{% else %}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 {% data variables.product.prodname_dotcom %} from the desktop, and work with a local copy of the repository.{% endif %}
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 {% data variables.product.prodname_dotcom %}. 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 {% data variables.product.prodname_dotcom %} repository from your desktop before, you'll need to authenticate to {% data variables.product.prodname_dotcom %} 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 {% data variables.product.prodname_dotcom %} from your desktop. These tools allow you to authenticate to {% data variables.product.prodname_dotcom %}, clone a repository, track your changes, and push the changes to {% data variables.product.prodname_dotcom %}.
- 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 {% data variables.product.prodname_cli %}, a command-line interface that lets you perform many actions on {% data variables.product.prodname_dotcom %}, such as creating a pull request or forking a repository. For more information, see AUTOTITLE and AUTOTITLE.
- If you'd prefer to use a visual interface, you can use a visual Git client such as {% data variables.product.prodname_desktop %}. With {% data variables.product.prodname_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 AUTOTITLE.
- If you want to work in one place, you can often do most things from your editor. An editor such as {% data variables.product.prodname_vscode_shortname %} includes an integrated terminal and buttons for common Git commands, so you can edit files and push your changes to {% data variables.product.prodname_dotcom %} all from one place. You can also install an extension to work directly with pull requests and issues on {% data variables.product.prodname_dotcom %}. To get started, see Download {% data variables.product.prodname_vscode_shortname %}.
The following table provides a comparison between the tools you can use to work with repositories on {% data variables.product.prodname_dotcom %}, both in your browser and from your desktop.
You can perform the whole {% data variables.product.prodname_dotcom %} 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 {% data variables.product.prodname_dotcom %}-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 {% data variables.product.product_name %} with each of these tools, see AUTOTITLE.
| Tool | Use case | Browser or desktop |
|---|---|---|
| On {% data variables.location.product_location %} | You want a visual interface and need to make quick, simple changes, typically involving a single commit. For an introduction, see AUTOTITLE. | Browser |
| {% ifversion fpt or ghec %} | ||
| github.dev | You want to make more complex changes to a repository than is possible on {% data variables.product.prodname_dotcom_the_website %}, but don't need to work with a terminal or tools you have installed on your computer. For more information, see AUTOTITLE. | Browser |
| {% data variables.product.prodname_github_codespaces %} | You need the resources of a computer to do things like run scripts, create a test build of your project, or install dependencies, and you want to get started quickly by working in a cloud-based environment. For more information, see AUTOTITLE. | Browser or desktop |
| {% endif %} | ||
| {% data variables.product.prodname_desktop %} | You want to work with files locally, and would prefer a visual interface to use Git, visualize changes, and interact with {% data variables.product.product_name %}. For more information, see AUTOTITLE. | Desktop |
| IDE or text editor | You're working with more complex files and projects and want everything in one place. | Desktop |
| Command-line Git and {% data variables.product.prodname_cli %} | You'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 AUTOTITLE and AUTOTITLE. | Desktop |
| {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API | You want to automate common tasks such as backing up your data, or create integrations that extend {% data variables.product.prodname_dotcom %}. For more information, see AUTOTITLE. | Browser or desktop |