# quill-tar

> Utility functions for packing and unpacking quill `system` tarballs

Latest version **0.2.2** (published 2013-04-15) · 0 weekly downloads

## Install

```sh
npm install quill-tar
pnpm add quill-tar
yarn add quill-tar
bun add quill-tar
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.2 |
| Published | 2013-04-15 |
| First published | 2013-04-15 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | 0.8.x |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+18 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Nodejitsu Inc. |
| Maintainers | mmalecki |
| Keywords | quill, tar, utility |

## Links

- npm: https://www.npmjs.com/package/quill-tar
- Repository: https://github.com/opsmezzo/quill-tar
- npm.io page: https://npm.io/package/quill-tar

## Dependencies (5)

- [tar](https://npm.io/package/tar.md) 0.1.x
- [utile](https://npm.io/package/utile.md) 0.0.x
- [fstream](https://npm.io/package/fstream.md) 0.1.x
- [uid-number](https://npm.io/package/uid-number.md) 0.0.x
- [fstream-ignore](https://npm.io/package/fstream-ignore.md) 0.0.5

## Alternatives

- [lodash.startswith](https://npm.io/package/lodash.startswith.md) — 769.7K weekly downloads
- [@tarojs/service](https://npm.io/package/@tarojs/service.md) — 33.9K weekly downloads
- [io.extendreality.tilia.indicators.spatialtargets.unity](https://npm.io/package/io.extendreality.tilia.indicators.spatialtargets.unity.md) — 131 weekly downloads
- [@rtarojs/taro](https://npm.io/package/@rtarojs/taro.md) — 90 weekly downloads
- [node-branch-io](https://npm.io/package/node-branch-io.md) — 50 weekly downloads

## Recent versions

- 0.2.2 (latest) — 2013-04-15

## README

# quill-tar

`quill-tar` contains utility functions for packing and unpacking quill `system` tarballs. 

## Motivation

Unpacking `system` tarballs is a fundamental piece of functionality that will be reused in multiple parts of [conservatory][0]

## Usage

There are two core methods:

* `quillTar.pack(tarball, dir, files, callback)`

``` 
@tarball {string|Stream} Location of the tarball to create or stream to pipe to.
@dir {string} Base directoty the tarball is being created from.
@files {Array} List of files to include in the tarball
@callback {function} Continuation to respond to when complete.
```

* `quillTar.unpack(tarball, target, options, callback)`

```
@tarball {string} Path to the tarball to untar.
@target {string} Parent directory to untar into
@options {Object} Options for untaring
@callback {function} Continuation to respond to when complete
```  
  
Lets take a look at some sample usage:

``` js
  var quillTar = require('quill-tar');
  
  quillTar.unpack(
    '/path/to/some/tarball.tgz',
    '/parent/dir/to/untar/into',
    {
      modes: {
        exec: 0777 & (~022), 
        file: 0666 & (~022),
        umask: 022
      }
    },
    function (err, target) {
      //
      // This will output the absolute path of the directory
      // processed by `quill-tar`
      //
      console.dir(target);
    }
  );
```

## Installation

### Installing npm (node package manager)

``` bash
  $ curl http://npmjs.org/install.sh | sh
```

### Installing quill-tar

``` bash
  $ npm install quill-tar
```

## Tests

All tests are written with [vows][1]:

``` bash
  $ npm test
```

## Authors
[Nodejitsu Inc][2]

## License and Attribution

* (C) 2011, Isaac Schlueter
* (C) 2012, Nodejitsu Inc. 
* Adapted from [npm][3] under MIT. 
* Adapted License: **Private and not Open Source**

[0]: http://github.com/nodejitsu/conservatory
[1]: http://vowsjs.org
[2]: http://nodejitsu.com
[3]: http://npmjs.org

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