# fetch-gitee-repo

> git repo down load

Latest version **1.0.1** (published 2022-05-01) · ISC license · 0 weekly downloads

## Install

```sh
npm install fetch-gitee-repo
pnpm add fetch-gitee-repo
yarn add fetch-gitee-repo
bun add fetch-gitee-repo
```

## 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.1 |
| Published | 2022-05-01 |
| First published | 2022-05-01 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | silverwu |
| Keywords | gitee, repo, download |

## Links

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

## Dependencies (3)

- [rimraf](https://npm.io/package/rimraf.md) ^3.0.2
- [download](https://npm.io/package/download.md) ^8.0.0
- [gitee-clone](https://npm.io/package/gitee-clone.md) ^1.0.0

## Recent versions

- 1.0.1 (latest) — 2022-05-01
- 1.0.0 — 2022-05-01

## README

#download-gitee-repo
Download and extract a git repository (GitHub, GitLab, Bitbucket, gitee) from node.
#Installation
```markdown
$ npm install download-gitee-repo
```
#API
##download(repository, destination, options, callback)
Download a git repository to a destination folder with options, and callback.
##repository
The shorthand repository string to download the repository from:
* GitHub - github:owner/name or simply owner/name
* Gitee - giteehub:owner/name or simply owner/name
* GitLab - gitlab:owner/name
* Bitbucket - bitbucket:owner/name

The repository parameter defaults to the master branch, but you can specify a branch or tag as a URL fragment like owner/name#my-branch.
In addition to specifying the type of where to download, you can also specify a custom origin like gitlab:custom.com:owner/name.
Custom origin will default to https or git@ for http and clone downloads respectively, unless protocol is specified.
Feel free to submit an issue or pull request for additional origin options.
#Examples
##Shorthand
Using http download from Github repository at master.
```javascript
download('flippidippi/download-git-repo-fixture', 'test/tmp', function (err) {
  console.log(err ? 'Error' : 'Success')
})
```

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