Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gyumeijie/github-files-fetcher
Download a specific folder or file from a GitHub repo through command line
https://github.com/gyumeijie/github-files-fetcher
cli command-line command-line-tool commandline-options download download-file downloader downloads fetch fetcher file file-downloader files files-downloader github github-repository npm-package
Last synced: 2 days ago
JSON representation
Download a specific folder or file from a GitHub repo through command line
- Host: GitHub
- URL: https://github.com/gyumeijie/github-files-fetcher
- Owner: Gyumeijie
- Created: 2018-07-06T08:17:23.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-09-19T13:30:56.000Z (over 3 years ago)
- Last Synced: 2024-12-17T07:13:06.722Z (10 days ago)
- Topics: cli, command-line, command-line-tool, commandline-options, download, download-file, downloader, downloads, fetch, fetcher, file, file-downloader, files, files-downloader, github, github-repository, npm-package
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/github-files-fetcher
- Size: 101 KB
- Stars: 156
- Watchers: 4
- Forks: 24
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Introduction [](https://opensource.org/licenses/MIT)
The `github-files-fetcher` is designed for downloading parts of a github repository. This is very useful if you have a low bandwidth network or only need a particular file or subdirectory from a large repository. If you want to download a whole repository, prefer `git clone`.
# Installation
Run `npm install -g github-files-fetcher`
## Basic usage
```sh
fetcher --url=resource_url --out=output_directory
```
For example:
```sh
fetcher --url="https://github.com/Gyumeijie/github-files-fetcher/blob/master/CHANGELOG.md" --out=/tmp
```
## Authentication
The default unauthorized API access rate is **60** times per hour, which is usually enough.
You can surpass this with authentication, using one of the following three ways:
1. The --auth commandline option
This option takes the form of `--auth=username:password`, where the password can be either the login password for your github account or the personal access token which can be generated in https://github.com/settings/tokens.
2. Default configuration file
The default configuration file is `~/.download_github`, and the config file is a **json file**.
3. Designate via --file commandline option
For example, you can use `~/config.json` as configuration file.
```sh
# download a directory
fetcher --file="~/config.json" --url="https://github.com/reduxjs/redux/tree/master/examples/async" --out="~/"
# download a single file
fetcher --file="~/config.json" --url="https://github.com/Gyumeijie/github-files-fetcher/blob/master/index.js" --out="~/"
```
This is a **template** for the configuration file:
```json
{
"auth": {
"username" : "your_github_name",
"password" : "password_or_api_access_token"
},
"alwaysUseAuth" : true,
"timeout" : 5000
}
```
### Behavior
When the default unauthorized API access rate exceeded, `github-files-fetcher` will automatically switch to use authentication if provided through one of the ways above.
`github-files-fetcher` requests resources without authentication by default to improve performance. However, this incurs a delay once the default unauthorized API access rate exceeded. To avoid this problem you can specify the `--alwaysUseAuth` option so `github-files-fetcher` always uses authentication.
# Environment
`node >= 6`
# Related works
There are some other good tools that function similarly:
- GitZip (Credits to Kino, Browser Extensions)
- [Firefox Addon](https://addons.mozilla.org/en-US/firefox/addon/gitzip/)
- [Chrome Extension](https://chrome.google.com/webstore/detail/gitzip-for-github/ffabmkklhbepgcgfonabamgnfafbdlkn)
- [DownGit](https://minhaskamal.github.io/DownGit/#/home) (Credits to Minhas Kamal, Web Page)