# progress-download

> download file with progress bar

Latest version **1.0.4** (published 2017-07-28) · ISC license · 0 weekly downloads

## Install

```sh
npm install progress-download
pnpm add progress-download
yarn add progress-download
bun add progress-download
```

Provides the command `download`.

## 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.4 |
| Published | 2017-07-28 |
| First published | 2017-07-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | zoujie.wzj |
| Maintainers | yibn2008 |
| Keywords | progress-download |

## Links

- npm: https://www.npmjs.com/package/progress-download
- Repository: https://github.com/yibn2008/progress-download
- Homepage: https://github.com/yibn2008/progress-download#readme
- Issues: https://github.com/yibn2008/progress-download/issues
- npm.io page: https://npm.io/package/progress-download

## Dependencies (7)

- [chalk](https://npm.io/package/chalk.md) ^2.0.1
- [debug](https://npm.io/package/debug.md) ^2.6.8
- [rimraf](https://npm.io/package/rimraf.md) ^2.6.1
- [download](https://npm.io/package/download.md) ^5.0.3
- [filesize](https://npm.io/package/filesize.md) ^3.5.10
- [progress](https://npm.io/package/progress.md) ^2.0.0
- [commander](https://npm.io/package/commander.md) ^2.11.0

## Recent versions

- 1.0.4 (latest) — 2017-07-28
- 1.0.3 — 2017-07-28
- 1.0.2 — 2017-07-27
- 1.0.1 — 2017-07-27
- 1.0.0 — 2017-07-27

## README

# progress-download

download file with progress bar, support CLI and node API

## Screenshot

![progress-download](https://user-images.githubusercontent.com/4136679/28660193-9d75827a-72e4-11e7-8eaf-d0a86f5ea398.gif)

## CLI

### Install

Install as a global module

```bash
$ npm install progress-download -g
```

### Usage

Use `download` command to download a `url`

```bash
$ download -h

  Usage: download [options] <url>

  download file with progress bar (like wget)


  Options:

    -V, --version        output the version number
    -o, --output <name>  output file name
    -h, --help           output usage information

  Examples:

    $ download http://example.com/foobar.zip
    $ download http://example.com/foobar.zip -o xxx.zip

```

## Node API

### Usage

Use it like [download](https://github.com/kevva/download) module

```js
const download = require('progress-download')

let url = 'https://github.com/tj/commander.js/archive/master.zip'
let filename = 'commander.zip'
download(url, {
  filename
}).then(() => {
  console.log('download succeed')
}, err => {
  console.log('download failed')
})
```

### API

```js
download(url, [destination], [options])
```

- url: url to download
- destination: path where you download to
- options: more other download options

same API as [download api](https://github.com/kevva/download#api)

## License

MIT

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