Clone a folder in a Git repository with sparse-checkout

Photo by Skye Studios / Unsplash

Git is unavoidable for versioning changes in a project and improving the collaboration between many developers. It is also behind the rise of open source software, where people can build software with the source code accessible to everyone.

Clone a repository consists in making a copy of the remote repository to your local computer. However, sometimes we may want to clone only a specific folder in a repository.

Use case

The source code related to each article on this blog is stored in a single Git repository on GitHub.

GitHub - tericcabrel/blog-tutorials: Sample code of my blog tutorials

Sample code of my blog tutorials. Contribute to tericcabrel/blog-tutorials development by creating an account on GitHub.

GitHubtericcabrel

A user reading a blog post and wanting to clone just the folder in the repository usually clones the whole repository and picks what they need. I do the same when consuming the blog posts of other authors.

Git sparse checkout

Starting the version 2.25.0, Git introduced a nice feature called sparse-checkout combined with other commands, allows the cloning of a single folder in a Git repository.

Here is what the repository looks like:

Let's say we want to clone the folder deploy-node-app.

Make sure you have a version of Git higher than 2.25.0; here is the download link.

On your local computer, run the commands below:

git clone --no-checkout https://github.com/tericcabrel/blog-tutorials.git

cd blog-tutorials

git sparse-checkout init --cone

git sparse-checkout set deploy-node-app

git checkout @

The command git sparse-checkout init --cone initialize the folder with only the file at root directory (except the .git directory). For this repo, we only have one file: README.md.

The command git sparse-checkout set deploy-node-app pick the folder deploy-node-app and add it in the repo. Now we the Readme file and the folder of the application we want to use.

Check the cloned repository to verify you only have the desired folder.

Check out the documentation to learn more about the sparse checkout.

Git - git-sparse-checkout Documentation

git-sparse-checkout Documentation

If you are working with Monorepo, you can use sparse-checkout to speed up you CI/CD pipeline. Check out this great article on the GitHub blog.

Bring your monorepo down to size with sparse-checkout

Git 2.25.0 includes a new experimental git sparse-checkout command that makes the existing feature easier to use, along with some important performance benefits for large repositories.

The GitHub BlogDerrick Stolee

Follow me on Twitter or subscribe to my newsletter to avoid missing the upcoming posts and the tips and tricks I occasionally share.