# quick-github-downloader

> Downloads the files from a github repository (and you can specify which directory to grab) and puts them in a specified output folder - all in js.

Latest version **1.0.41** (published 2020-04-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install quick-github-downloader
pnpm add quick-github-downloader
yarn add quick-github-downloader
bun add quick-github-downloader
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.41 |
| Published | 2020-04-23 |
| First published | 2018-12-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 4.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Cornchip |
| Maintainers | cornchip |
| Keywords | github, downloader |

## Links

- npm: https://www.npmjs.com/package/quick-github-downloader
- Repository: https://github.com/Cornchipss/Quick-Github-Downloader
- Homepage: https://github.com/Cornchipss/Quick-Github-Downloader#readme
- Issues: https://github.com/Cornchipss/Quick-Github-Downloader/issues
- npm.io page: https://npm.io/package/quick-github-downloader

## Dependencies (3)

- [ncp](https://npm.io/package/ncp.md) ^2.0.0
- [rimraf](https://npm.io/package/rimraf.md) ^2.6.2
- [download-github-repo](https://npm.io/package/download-github-repo.md) ^0.1.4

## Recent versions

- 1.0.41 (latest) — 2020-04-23
- 1.0.4 — 2020-04-23
- 1.0.3 — 2019-04-19
- 1.0.2 — 2019-04-19
- 1.0.1 — 2018-12-22
- 1.0.0 — 2018-12-22

## README

# Quick-Github-Downloader
Downloads the files from a github repository (and you can specify which directory to grab) and puts them in a specified output folder - all in js.

All it does:
~~~~
const githubDownloader = require('quick-github-downloader');

githubDownloader(repository, githubSubdir, outputDir, callback);
~~~~

This will download the repository, select the sub dir you want, copy it to the output directory and delete the other unneeded stuff.

For example,
~~~~
githubDownloader('Cornchipss/Quick-Github-Downloader', '/sample', './test-output', () =>
{
    console.log('Shazam!');
    // do stuff with the downloaded files located in ./test-output
});
~~~~

---
_Source: https://npm.io/package/quick-github-downloader · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
