# progress-extract

> extract compress file with progress bar

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

## Install

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

Provides the command `extract`.

## 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.2 |
| Published | 2017-07-28 |
| First published | 2017-07-28 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | zoujie.wzj |
| Maintainers | yibn2008 |
| Keywords | progress-extract |

## Links

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

## Dependencies (7)

- [chalk](https://npm.io/package/chalk.md) ^2.0.1
- [debug](https://npm.io/package/debug.md) ^2.6.8
- [tar.gz2](https://npm.io/package/tar.gz2.md) ^1.0.0
- [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
- [extract-zip](https://npm.io/package/extract-zip.md) ^1.6.5

## Recent versions

- 1.0.2 (latest) — 2017-07-28
- 1.0.1 — 2017-07-28
- 1.0.0 — 2017-07-28

## README

# progress-extract

extract compress file with progress bar, support CLI and node API

## Screenshot

![progress-extract](https://user-images.githubusercontent.com/4136679/28699990-8995b946-737f-11e7-9f61-af0d19534f8a.gif)

## CLI

### Install

Install as a global module

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

### Usage

Use `extract` command to extract file

```bash
$ extract -h

  Usage: extract <file>

  extract file with progress bar


  Options:

    -V, --version          output the version number
    -d, --directory <dir>  target dir to extract
    -h, --help             output usage information

  Examples:

    $ extract example.tar.gz

```

## Node API

### Usage

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

let file = '/path/to/example.tar.gz'
let target = process.cwd()
extract(file, target)
  .then(() => {
    console.log('extract succeed')
  }, err => {
    console.log('extract failed')
  })
```

### API

```js
extract(source, [destination])
```

- source: source file (support `.zip`, `.tgz`, `.tar.gz`)
- destination: path where you extract to

Return Promise

## License

MIT

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