terminal git clone from GitHub repo

https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/cloning-a-repository

GitHub Docs

English

Free, Pro, and Team 

GitHub.com Creating, cloning, and archiving repositories Cloning a repository from GitHub Cloning a repository

Cloning a repository

When you create a repository on GitHub, it exists as a remote repository. You can clone your repository to create a local copy on your computer and sync between the two locations.

MacWindowsLinux

In this article

• About cloning a repository
• Cloning a repository using the command line
• Cloning a repository to GitHub Desktop
• Cloning an empty repository
• Troubleshooting cloning errors
• Further reading

About cloning a repository

You can clone a repository from GitHub to your local computer to make it easier to fix merge conflicts, add or remove files, and push larger commits. When you clone a repository, you copy the repository from GitHub to your local machine.

Cloning a repository pulls down a full copy of all the repository data that GitHub has at that point in time, including all versions of every file and folder for the project. You can push your changes to the remote repository on GitHub, or pull other people's changes from GitHub. For more information, see "Using common Git commands".

You can clone your existing repository or clone another person's existing repository to contribute to a project.

Tip: You can also clone a repository using the GitHub CLI. For more information, see "gh repo clone" in the GitHub CLI documentation.

Cloning a repository using the command line

1. On GitHub, navigate to the main page of the repository.

2. Above the list of files, click  Code.

   

3. To clone the repository using HTTPS, under "Clone with HTTPS", click . To clone the repository using an SSH key, including a certificate issued by your organization's SSH certificate authority, click Use SSH, then click . To clone a repository using GitHub CLI, click Use GitHub CLI, then click .

   

   

4. Open Terminal.

5. Change the current working directory to the location where you want the cloned directory.

6. Type git clone, and then paste the URL you copied earlier.

   $ git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY

7. Press Enter to create your local clone.

   $ git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY
   > 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.

Cloning a repository to GitHub Desktop

1. On GitHub, navigate to the main page of the repository.

2. Above the list of files, click  Code.

   

3. Click  Open with GitHub Desktop to clone and open the repository with GitHub Desktop.

   

4. Follow the prompts in GitHub Desktop to complete the clone.

For more information, see "Cloning a repository from GitHub to GitHub Desktop."

Cloning an empty repository

An empty repository contains no files. It's often made if you don't initialize the repository with a README when creating it.

1. On GitHub, navigate to the main page of the repository.

2. To clone your repository using the command line using HTTPS, under "Quick setup", click . To clone the repository using an SSH key, including a certificate issued by your organization's SSH certificate authority, click SSH, then click .

   

   Alternatively, to clone your repository in Desktop, click  Set up in Desktop and follow the prompts to complete the clone.

   

3. Open Terminal.

4. Change the current working directory to the location where you want the cloned directory.

5. Type git clone, and then paste the URL you copied earlier.

   $ git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY

6. Press Enter to create your local clone.

   $ git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY
   > 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.

Troubleshooting cloning errors

When cloning a repository it's possible that you might encounter some errors.

If you're unable to clone a repository, check that:

• You can connect using HTTPS. For more information, see "HTTPS cloning errors."
• You have permission to access the repository you want to clone. For more information, see "Error: Repository not found."
• The default branch you want to clone still exists. For more information, see have permission to access the repository you want to clone. For more information, see "Error: Remote HEAD refers to nonexistent ref, unable to checkout."

Further reading

• "Troubleshooting connectivity problems"

Did this doc help you?

Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

 Make a contribution

Or, learn how to contribute.

Still need help?

 Ask the GitHub community  Contact support

• © 2021 GitHub, Inc.
• Terms 
• Privacy 
• Security
• Status
• Help
• Contact GitHub
• Pricing
• Developer API
• Training
• About