@siddharthshyniben/sip v1.0.0

sip

sip is a command line utility that helps you compress files. It is designed with text and similar files in mind, so be careful when compressing images with this!

sip uses the LZW compression algorithm compression algorithm.

Installing

sip requires node.js to be installed. You can install sip by running:

$ npm install @siddharthshyniben/sip -g

Using sip

# sip a file
sip somefile.txt

# unsip a file
sip -d somefile.txt.sip

# sip a file, but keep the original
sip -k somefile.txt

# sip text
sip -i "TOBEORNOTTOBEORTOBEORNOTTOBE"

# sip a file but write it to stdout, and keep the file
sip somefile.txt -c

# sip many
sip somefile.txt someotherfile.md somethingelse.css

# view help
sip

Contributing

Contributions are absolutely welcome! To contribute:

1. Fork and clone this repository
2. Create a new branch
3. Make your changes then commit them
4. Push to your branch
5. Open a Pull Request

Alternatively, check out GitHub documentation on creating a Pull Request

Contributors

Thanks to the following people who contributed to sip:

• @siddharthshyniben

Contact

You can reach me at siddharth.muscat@gmail.com

License

GPL-3.0