# gzipme

> Gzipme is a module and CLI tool to compress files to gzip

Latest version **1.0.0** (published 2020-08-29) · 0 weekly downloads

## Install

```sh
npm install gzipme
pnpm add gzipme
yarn add gzipme
bun add gzipme
```

Provides the command `gzipme`.

## 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.0 |
| Published | 2020-08-29 |
| First published | 2013-07-01 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 11.0.0 |
| Dependencies | 1 |
| Unpacked size | 10.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 33 |
| Author | Caio Ribeiro Pereira |
| Maintainers | caio-ribeiro-pereira |
| Keywords | gzip, zlib, compression, compress, gzip-files |

## Links

- npm: https://www.npmjs.com/package/gzipme
- Repository: https://github.com/caio-ribeiro-pereira/gzipme
- Homepage: https://github.com/caio-ribeiro-pereira/gzipme#readme
- Issues: https://github.com/caio-ribeiro-pereira/gzipme/issues
- npm.io page: https://npm.io/package/gzipme

## Dependencies (1)

- [commander](https://npm.io/package/commander.md) 6.1.0

## 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

- 1.0.0 (latest) — 2020-08-29
- 0.1.2 — 2018-08-08
- 0.1.1 — 2017-07-23
- 0.1.0 — 2016-09-30
- 0.0.9 — 2013-07-19
- 0.0.8 — 2013-07-19
- 0.0.7 — 2013-07-10
- 0.0.6 — 2013-07-08
- 0.0.5 — 2013-07-08
- 0.0.4 — 2013-07-06
- 0.0.3 — 2013-07-04
- 0.0.2 — 2013-07-04
- 0.0.1 — 2013-07-01

## README

## Gzipme

[![Donate via Paypal](https://img.shields.io/badge/donate-paypal-blue)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=L8MUNAKECUULY&source=url) [![Build Status](https://travis-ci.org/caio-ribeiro-pereira/gzipme.svg?branch=master)](https://travis-ci.org/caio-ribeiro-pereira/gzipme) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/0e2b271a992343e8804ad868a9b17354)](https://www.codacy.com/manual/caio-ribeiro-pereira/gzipme?utm_source=github.com&utm_medium=referral&utm_content=caio-ribeiro-pereira/gzipme&utm_campaign=Badge_Grade) [![Coverage Status](https://coveralls.io/repos/github/caio-ribeiro-pereira/gzipme/badge.svg?branch=master)](https://coveralls.io/github/caio-ribeiro-pereira/gzipme?branch=master) ![npm](https://img.shields.io/npm/dt/gzipme) ![GitHub](https://img.shields.io/github/license/caio-ribeiro-pereira/gzipme) ![npm](https://img.shields.io/npm/v/gzipme) ![GitHub stars](https://img.shields.io/github/stars/caio-ribeiro-pereira/gzipme) ![GitHub forks](https://img.shields.io/github/forks/caio-ribeiro-pereira/gzipme)


## About

A simple and tiny lib/cli for gzip file compression. It's very simple to use it, take a look:

### Instalation

``` bash
npm install gzipme
```

## Module version
### How to use

``` javascript
// Load gzipme module
const gzipme = require('gzipme');

// Compress 'file.txt' to 'file.txt.gz' in the same dir.
gzipme('file.txt');

// Compress 'file.txt' into the same file.
gzipme('file.txt', { overwrite: true });

// Compress 'file.txt' to generate a file named as 'compressed.txt' in the same dir.
gzipme('file.txt', { output: 'compressed.txt' });

// Compress 'file.txt' using best compress mode (few bytes, but slow compression).
gzipme('file.txt', { mode: 'best' });

// Compress 'file.txt' using fast compress mode (fast compression, but more bytes).
gzipme('file.txt', { mode: 'fast' });
```

[Click here](https://nodejs.org/api/zlib.html#zlib_zlib_constants) to understand the Node.js Zlib compreension mode.


## CLI version
### Instalation

``` bash
npm install -g gzipme
```

### All commands

``` bash
# It's the same as function 'gzipme('file.txt')'.
gzipme file.txt
# It's the same as function 'gzipme('file.txt', { overwrite: true });'.
gzipme -o file.txt
# It's the same as function 'gzipme('file.txt', { output: 'compressed.txt' });'.
gzipme -O compressed.txt file.txt
# It's the same as function 'gzipme('file.txt', { mode: 'fast' });'.
gzipme -c best file.txt
# It's the same as function 'gzipme('file.txt', { mode: 'fast' });'.
gzipme -c fast file.txt
```

## Running tests

Just clone this repository, and follow the commands below:
``` bash
git clone git@github.com:caio-ribeiro-pereira/gzipme.git
cd gzipme
npm install
npm test
```

## Author

Caio Ribeiro Pereira <caio.ribeiro.pereira@gmail.com>  
Twitter: <http://twitter.com/crp_underground>  
About me: <https://crpwebdev.github.io>

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