Dir Archiver

Compress a whole directory (including subdirectories) into a zip file, with options to exclude specific files, or directories.

Installation

1$ npm install dir-archiver

Usage

API

1// Require modules.
2var DirArchiver = require('dir-archiver');
3
4// Create an array with the files and directories to exclude.
5const excludes = ['directory_name', 'file.extension'];
6
7/**
8 * Create a dir-archiver object. 
9 * @param {string} directoryPath - The path of the folder to archive.
10 * @param {string} zipPath - The path of the zip file to create.
11 * @param {Boolean} includeBaseDirectory - Includes a base directory at the root of the archive.
12 * For example, if the root folder of your project is named "your-project", setting
13 * includeBaseDirectory to true will create an archive that includes this base directory.
14 * If this option is set to false the archive created will unzip its content to
15 * the current directory.
16 * @param {array} excludes - A list with the names of the files and folders to exclude.
17*/
18var archive = new DirArchiver('path/to/directory', 'path/to/desination/zipfile.zip', true, excludes);
19
20// Create the zip file.
21archive.createZip();

Command Line Interface

1Usage: dir-archiver --src <path-to-directory> --dest <path-to-file>.zip --includebasedir true|false --exclude folder-name file-name.extention
2
3Options:
4  --src             The path of the folder to archive.                            [string][required]
5  --dest            The path of the zip file to create.                           [string][required]
6  --includebasedir  Includes a base directory at the root of the archive.
7                    For example, if the root folder of your project is named
8                    "your-project", setting this option to true will create
9                    an archive that includes this base directory.
10                    If this option is set to false the archive created will
11                    unzip its content to the current directory.                               [bool]
12  --exclude         A list with the names of the files and folders to exclude.               [array]