Github-dlr

Download individual files and folders from GitHub recursively.

github-dlr-demo.mp4

Motivation

The project aims to save time and resources by allowing users to download only the specific folders and files they need from a GitHub repository, without the hassle of cloning the entire repo. It's designed for efficiency, making development and learning more streamlined.

Install

Requires Python version 3.8 or higher.

pip install github-dlr

or using pipx

pipx install github-dlr

Usage

Note

Using the tool is straightforward, copy the GitHub URL of the target repository folder and paste it after the command github-dlr or it's alias gh-dlr.

github-dlr <github_path>

# Basic Example
github-dlr https://github.com/makccr/wallpapers/blob/master/wallpapers/space

Note

By default it will download the entire folder from GitHub and place in the current directory from where the command is being executed. If you want to specify a different output directory, you can do it via the --output or -o flag.

github-dlr --output wallpapers https://github.com/makccr/wallpapers/blob/master/wallpapers/space

Find all available options using --help

usage: github-dlr [-h] [-o] [-v] github_path

Download folders and files from Github.

positional arguments:
  github_path     Github directory full URL path

options:
  -h, --help      show this help message and exit
  -o, --output   Destination directory to download to
  -v, --version   show program version number and exit

Thanks for using github-dlr!

LICENSE

MIT License © Rocktim Saikia 2024