# repo-retriever

> Retrieve and store GitHub repo as a zip archive.

Latest version **1.1.0** (published 2021-05-03) · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install repo-retriever
pnpm add repo-retriever
yarn add repo-retriever
bun add repo-retriever
```

Provides the command `repo-retriever`.

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2021-05-03 |
| First published | 2020-12-06 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 76.4 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | baselwebdev |

## Links

- npm: https://www.npmjs.com/package/repo-retriever
- npm.io page: https://npm.io/package/repo-retriever

## Dependencies (9)

- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [yargs](https://npm.io/package/yargs.md) ^15.4.1
- [fs-extra](https://npm.io/package/fs-extra.md) ^9.0.1
- [typescript](https://npm.io/package/typescript.md) ^4.0.0
- [extract-zip](https://npm.io/package/extract-zip.md) 2.0.1
- [@types/yargs](https://npm.io/package/@types/yargs.md) ^15.0.11
- [@octokit/rest](https://npm.io/package/@octokit/rest.md) ^18.0.10
- [@octokit/types](https://npm.io/package/@octokit/types.md) ^5.5.0
- [@types/fs-extra](https://npm.io/package/@types/fs-extra.md) ^9.0.4

## Recent versions

- 1.1.0 (latest) — 2021-05-03
- 1.0.2 — 2020-12-06
- 1.0.1 — 2020-12-06
- 1.0.0 — 2020-12-06

## README

# repo-retriever

Retrieve and store GitHub repo as a zip archive.

This repo used to be part of an internal monolithic software I developed for a personal project.

They have been open-sourced and split into three repos:

- [Repo retriever](https://github.com/baselwebdev/repo-retriever)

- [Software orchestration](https://github.com/baselwebdev/software-orchestration)

- [Infrastructure management](https://github.com/baselwebdev/infrastructure-management)

## TODO

- [ ] Add tests and get 100% test coverage

- [ ] Add other distributed version control and source management support

## Install

Install with [npm](https://www.npmjs.com/):

```sh
$ npm install repo-retriever
```

## Usage

Using the CLI

```sh
$ node bin/repoRetriever.js --help
Options:
  --help                Show help                                      [boolean]
  --version             Show version number                            [boolean]
  --repo, -r            The name of the repo are trying to retrieve.
                                                             [string] [required]
  --owner, -o           The name of the owner of the repo you are trying to
                        retrieve.                            [string] [required]
  --branch, -b          The name of the branch of the repo you are trying to
                        retrieve.                            [string] [required]
  --githubToken, --ght  This is required when trying to retrieve private repos.
                                                                        [string]
```

## About

### Contributing

Pull requests are always welcome. 

For bugs and feature requests, [please create an issue](../../issues/new).

### Author

**Basel Ahmed**

* [github/baselwebdev](https://github.com/baselwebdev)
* [twitter/baselwebdev](https://twitter.com/baselwebdev)

### License

Copyright © 2020, [Basel Ahmed](https://github.com/baselwebdev).
Released under the [MIT License](LICENSE).

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