docs/content/get-started/quickstart/fork-a-repo.md

title, redirect_from, intro, permissions, versions, topics

title	redirect_from	intro	permissions	versions	topics
Fork a repo	/fork-a-repo/ /forking/ /articles/fork-a-repo /github/getting-started-with-github/fork-a-repo /github/getting-started-with-github/quickstart/fork-a-repo	A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project.	{% data reusables.enterprise-accounts.emu-permission-fork %}	fpt ghes ghae ghec * * * *	Pull requests Issues Notifications Accounts

About forks

Most commonly, forks are used to either propose changes to someone else's project or to use someone else's project as a starting point for your own idea. You can fork a repository to create a copy of the repository and make changes without affecting the upstream repository. For more information, see "Working with forks."

Propose changes to someone else's project

For example, you can use forks to propose changes related to fixing a bug. Rather than logging an issue for a bug you've found, you can:

• Fork the repository.
• Make the fix.
• Submit a pull request to the project owner.

Use someone else's project as a starting point for your own idea.

Open source software is based on the idea that by sharing code, we can make better, more reliable software. For more information, see the "About the Open Source Initiative" on the Open Source Initiative.

For more information about applying open source principles to your organization's development work on {% data variables.product.product_location %}, see {% data variables.product.prodname_dotcom %}'s white paper "An introduction to innersource."

{% ifversion fpt or ghes or ghec %}

When creating your public repository from a fork of someone's project, make sure to include a license file that determines how you want your project to be shared with others. For more information, see "Choose an open source license" at choosealicense.com.

{% data reusables.open-source.open-source-guide-repositories %} {% data reusables.open-source.open-source-learning-lab %}

{% endif %}

Prerequisites

If you haven't yet, you should first set up Git. Don't forget to set up authentication to {% data variables.product.product_location %} from Git as well.

Forking a repository

{% include tool-switcher %} {% webui %}

You might fork a project to propose changes to the upstream, or original, repository. In this case, it's good practice to regularly sync your fork with the upstream repository. To do this, you'll need to use Git on the command line. You can practice setting the upstream repository using the same octocat/Spoon-Knife repository you just forked.

1. On {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.product.product_location %}{% endif %}, navigate to the octocat/Spoon-Knife repository.
2. In the top-right corner of the page, click Fork.

{% endwebui %}

{% cli %}

{% data reusables.cli.cli-learn-more %}

To create a fork of a repository, use the gh repo fork subcommand.

gh repo fork <em>repository</em>

To create the fork in an organization, use the --org flag.

gh repo fork <em>repository</em> --org "octo-org"

{% endcli %}

{% desktop %} {% enddesktop %}

Cloning your forked repository

Right now, you have a fork of the Spoon-Knife repository, but you don't have the files in that repository locally on your computer.

{% include tool-switcher %} {% webui %}

1. On {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.product.product_location %}{% endif %}, navigate to your fork of the Spoon-Knife repository. {% data reusables.repositories.copy-clone-url %} {% data reusables.command_line.open_the_multi_os_terminal %} {% data reusables.command_line.change-current-directory-clone %}
2. Type git clone, and then paste the URL you copied earlier. It will look like this, with your {% data variables.product.product_name %} username instead of YOUR-USERNAME:

$ git clone https://{% data variables.command_line.codeblock %}/<em>YOUR-USERNAME</em>/Spoon-Knife

5. Press Enter. Your local clone will be created.

$ git clone https://{% data variables.command_line.codeblock %}/<em>YOUR-USERNAME</em>/Spoon-Knife
> Cloning into `Spoon-Knife`...
> remote: Counting objects: 10, done.
> remote: Compressing objects: 100% (8/8), done.
> remove: Total 10 (delta 1), reused 10 (delta 1)
> Unpacking objects: 100% (10/10), done.

{% endwebui %}

{% cli %}

{% data reusables.cli.cli-learn-more %}

To create a clone of your fork, use the --clone flag.

gh repo fork <em>repository</em> --clone=true

{% endcli %}

{% desktop %}

{% data reusables.desktop.choose-clone-repository %} {% data reusables.desktop.cloning-location-tab %} {% data reusables.desktop.cloning-repository-list %} {% data reusables.desktop.choose-local-path %} {% data reusables.desktop.click-clone %}

{% enddesktop %}

Configuring Git to sync your fork with the original repository

When you fork a project in order to propose changes to the original repository, you can configure Git to pull changes from the original, or upstream, repository into the local clone of your fork.

{% include tool-switcher %} {% webui %}

1. On {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.product.product_location %}{% endif %}, navigate to the octocat/Spoon-Knife repository. {% data reusables.repositories.copy-clone-url %} {% data reusables.command_line.open_the_multi_os_terminal %}
2. Change directories to the location of the fork you cloned.
   • To go to your home directory, type just cd with no other text.
   • To list the files and folders in your current directory, type ls.
   • To go into one of your listed directories, type cd your_listed_directory.
   • To go up one directory, type cd ...
3. Type git remote -v and press Enter. You'll see the current configured remote repository for your fork.

$ git remote -v
> origin  https://{% data variables.command_line.codeblock %}/<em>YOUR_USERNAME</em>/<em>YOUR_FORK</em>.git (fetch)
> origin  https://{% data variables.command_line.codeblock %}/<em>YOUR_USERNAME</em>/<em>YOUR_FORK</em>.git (push)

6. Type git remote add upstream, and then paste the URL you copied in Step 2 and press Enter. It will look like this:

$ git remote add upstream https://{% data variables.command_line.codeblock %}/octocat/Spoon-Knife.git

7. To verify the new upstream repository you've specified for your fork, type git remote -v again. You should see the URL for your fork as origin, and the URL for the original repository as upstream.

$ git remote -v
> origin    https://{% data variables.command_line.codeblock %}/<em>YOUR_USERNAME</em>/<em>YOUR_FORK</em>.git (fetch)
> origin    https://{% data variables.command_line.codeblock %}/<em>YOUR_USERNAME</em>/<em>YOUR_FORK</em>.git (push)
> upstream  https://{% data variables.command_line.codeblock %}/<em>ORIGINAL_OWNER</em>/<em>ORIGINAL_REPOSITORY</em>.git (fetch)
> upstream  https://{% data variables.command_line.codeblock %}/<em>ORIGINAL_OWNER</em>/<em>ORIGINAL_REPOSITORY</em>.git (push)

Now, you can keep your fork synced with the upstream repository with a few Git commands. For more information, see "Syncing a fork."

{% endwebui %}

{% cli %}

{% data reusables.cli.cli-learn-more %}

To configure a remote repository for the forked repository, use the --remote flag.

gh repo fork <em>repository</em> --remote=true

To specify the remote repository's name, use the --remote-name flag.

gh repo fork <em>repository</em> --remote-name "main-remote-repo"

{% endcli %}

Next steps

You can make any changes to a fork, including:

• Creating branches: Branches allow you to build new features or test out ideas without putting your main project at risk.
• Opening pull requests: If you are hoping to contribute back to the original repository, you can send a request to the original author to pull your fork into their repository by submitting a pull request.

Find another repository to fork

Fork a repository to start contributing to a project. {% data reusables.repositories.you-can-fork %}

{% ifversion fpt or ghec %}You can browse Explore to find projects and start contributing to open source repositories. For more information, see "Finding ways to contribute to open source on {% data variables.product.prodname_dotcom %}."

{% endif %}

Celebrate

You have now forked a repository, practiced cloning your fork, and configured an upstream repository. For more information about cloning the fork and syncing the changes in a forked repository from your computer see "Set up Git."

You can also create a new repository where you can put all your projects and share the code on {% data variables.product.prodname_dotcom %}. For more information see, "Create a repository."

Each repository in {% data variables.product.product_name %} is owned by a person or an organization. You can interact with the people, repositories, and organizations by connecting and following them on {% data variables.product.product_name %}. For more information see "Be social."

{% data reusables.support.connect-in-the-forum-bootcamp %}