# github-files

> Download the file at the given github address

Latest version **1.0.3** (published 2025-12-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install github-files
pnpm add github-files
yarn add github-files
bun add github-files
```

Provides the command `github-files`.

## Health

**Score 55/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2025-12-19 |
| First published | 2023-01-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 36 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | SoraKumo |
| Maintainers | sora_kumo |
| Keywords | github, download |

## Links

- npm: https://www.npmjs.com/package/github-files
- Repository: https://github.com/node-libraries/github-files
- Homepage: https://github.com/node-libraries/github-files#readme
- Issues: https://github.com/node-libraries/github-files/issues
- npm.io page: https://npm.io/package/github-files

## Dependencies (2)

- [commander](https://npm.io/package/commander.md) ^14.0.2
- [@node-libraries/promise-limit](https://npm.io/package/@node-libraries/promise-limit.md) ^1.0.5

## Recent versions

- 1.0.3 (latest) — 2025-12-19
- 1.0.2 — 2023-11-12
- 1.0.1 — 2023-11-12
- 1.0.0 — 2023-11-12
- 0.0.12 — 2023-06-26
- 0.0.11 — 2023-06-24
- 0.0.10 — 2023-05-13
- 0.0.9 — 2023-05-13
- 0.0.8 — 2023-05-13
- 0.0.7 — 2023-02-16
- 0.0.6 — 2023-01-29

## README

# github-files

Download the file at the given github address

## usage

```sh
Usage: github-files [options] [command]

Options:
  -V, --version                      output the version number
  -h, --help                         display help for command

Commands:
  list [options] <url>               Retrieving the file list
    -j, --json                        output json format
  download [options] <url> [outdir]  Download files
    -p, --parallels <parallels>       Number of parallel downloads
  help [command]                     display help for command
```

- Download files in the output folder with a parallel number of 5.

```sh
npx github-files download https://github.com/node-libraries/scaffold/tree/master/src output -p 5
```

## When called from a programme

```ts
import { getGitHubFileList, downloadGitHubFiles } from "github-files";

const main = async () => {
  const files = await getGitHubFileList(
    "https://github.com/node-libraries/scaffold/tree/master/src"
  );
  if (files) await downloadGitHubFiles(files, "output");
};
main();
```

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