---

cross-7zip

Cross-platform 7-Zip for Node.js

Installation

Install cross-7zip via npm.

``sh
npm i cross-7zip
`

or

`sh
npm i -g cross-7zip
`

API

$3

A wrapper class for creating 7-Zip archives using the command-line tool.
Example

$3

A wrapper class for extracting files from a 7-Zip archive using the command-line tool.
Example

$3

Compresses multiple files into a zipped file asynchronously.
Example

$3

Extracts files from a specified zipped file asynchronously.
Example

$3

Compresses multiple files into a zipped file synchronously.
Example

$3

Extracts files from a specified zipped file synchronously.
Example

CLI Tool Usage

This package also includes a CLI tool for quick and simple operations with 7-Zip.
Below are some examples of how to use it:

$3

Make sure the package is installed globally to access the CLI tool:

`bash
npm install -g cross-7zip
`

$3

Create an Archive

To compress files or directories into an archive, use the zip command:

`bash
seven zip
`

Extract Files from an Archive

To extract files from an archive, use the unzip command:

`bash
seven unzip [destination]
`

$3

Create example.7z from file1.txt folder

`bash
seven zip example.7z file1.txt folder
`

Extract Files from the example.7z into the ouput folder

`bash
seven unzip example.7z ouput
`

Supported Platforms and Architectures

This library relies on the 7-Zip executables, which support the following
platforms and architectures:

- Windows: arm64, x86, x64
- macOS: arm64, x86, x64
- Linux: arm, arm64, x86, x64`

For details, click here.

---

Resources

- Documentation
- 7-Zip
- execFileSync
- Windows
* Compress-Archive
* Expand-Archive
- Unix
* zip
* unzip

---