-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README with project details and usage instructions
- Loading branch information
1 parent
0a77e06
commit 5c6fab3
Showing
1 changed file
with
49 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,51 @@ | ||
# github-dl | ||
# Github-dl | ||
|
||
Download individual files and folders from Github without needing to clone the entire repo. | ||
|
||
[![Tests](https://github.com/rocktimsaikia/github-dl/actions/workflows/tests.yml/badge.svg)](https://github.com/rocktimsaikia/github-dl/actions/workflows/tests.yml) | ||
|
||
## 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 | ||
|
||
```sh | ||
pip install github-dl | ||
``` | ||
|
||
or using [pipx](https://pipx.pypa.io/) | ||
|
||
```sh | ||
pipx install cambd | ||
``` | ||
|
||
## Usage | ||
|
||
> Using the tool is straightforward, copy the Github URL of the target repository folder and paste it after the command `github-dl` or it's alias `gh-dl`. | ||
```sh | ||
github-dl <github_path> | ||
|
||
# Example | ||
github-dl https://github.com/linuxdotexe/nordic-wallpapers/tree/master/dynamic-wallpapers/Coast | ||
``` | ||
|
||
\ | ||
Find all available options using `--help` | ||
|
||
```sh | ||
usage: github-dl [-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-dl! | ||
``` |