Zipper

Simple & powerful CLI tool that will archive any directory.

Installation

$ npm install @repit/zipper --global

Usage

Navigate to the desired directory and execute:

$ zipper

Note: It will create an archive of all files in that directory including all files from all subdirectories.

The .zipignore file

By default, Zipper reads all files from a directory and all files from all subdirectories and archives them, but you can specify custom files/directories/patterns which will be ignored by Zipper.

By default, Zipper ignores the following files/directories:

• .DS_Store
• .git

Note: If you want to include .git files/folders in your archive, execute Zipper with the --git flag.

To add custom ignore rules create a .zipignore file in the directory from where you run zipper command.

.zipignore file structure:

# All lines which start with a `#` are considered comments.

# The following rule will ignore the `node_modules` file/directory from the base directory.
# NOTE: This rule will not ignore `node_modules` files/directories from subdirectories.
/node_modules

# The following rule will ignore the `node_modules` file/directory
# from the base directory and subdirectories.
node_modules

# The following rule will ignore all files/directories which start with `foo`.
# NOTE: It will ignore: `foo`, `foobar`, `foobar/baz.js` and so on.
foo*

The Archive

There are some hard-coded defaults:

• Zipper creates the archive in the same directory where Zipper runs.
• The name of created archive is always zipper.zip.
• .DS_Store files can not be included in the created archive.

License

MIT