Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/araxeus/unarchive

Automatically extract archives of various types
https://github.com/araxeus/unarchive

archive tar targz tgz uncompress zip

Last synced: 22 days ago
JSON representation

Automatically extract archives of various types

Awesome Lists containing this project

README

        

# unarchive

This tool is a utility wrapper around the [compressing](https://www.npmjs.com/package/compressing) package

it automatically detects the compression type (zip/tar/tar.gz) and extracts the content of the archive

## Installation

```bash
npm install unarchive
```

or

```bash
yarn add unarchive
pnpm add unarchive
bun add unarchive
```

## Usage

```js
//const unarchive = require('unarchive')
import unarchive from 'unarchive'

await unarchive(archiveName, 'outputFolder')
```

## Supported formats

- zip
- tar
- tar.gz / tgz