Go to file
Hazel 8702491740 [obama voice] let me be clear 2023-11-21 16:10:24 +00:00
all Docsgit add . 2023-11-21 16:02:46 +00:00
bin Docsgit add . 2023-11-21 16:02:46 +00:00
core Docsgit add . 2023-11-21 16:02:46 +00:00
downloader move /bin to peerdep to avoid duplicate downloads if using /all and /core 2023-11-12 19:55:19 +01:00
linux Docsgit add . 2023-11-21 16:02:46 +00:00
mac Docsgit add . 2023-11-21 16:02:46 +00:00
windows Docsgit add . 2023-11-21 16:02:46 +00:00
.gitignore binary distributions done 2023-11-11 21:03:21 +01:00
README.md [obama voice] let me be clear 2023-11-21 16:10:24 +00:00



Monorepo for the 8zip NPM organization.

The goal of this project is to easily bundle 7zip executables for use in Node.js projects.


Package Description
@8zip/bin 7zip binary distribution which automatically detects the platform it's installed on
@8zip/all All 7zip binaries shipped without automatic platform detection
@8zip/core Simple wrapper around the 7zip binary
@8zip/downloader The automation code behind creating these packages
@8zip/linux Linux binaries for 7zip
@8zip/mac macOS binaries for 7zip
@8zip/windows Windows binaries for 7zip


npm i @8zip/bin @8zip/core
yarn add @8zip/bin @8zip/core
pnpm add @8zip/bin @8zip/core
// if using @8zip/bin, @8zip/core will automatically detect the binary path
const { extract, compress } = require('@8zip/core')

await extract('path/to/file.7z', 'path/to/extract/to')
await compress('path/to/file.7z', 'path/to/compress')

More detailed documentation can be found in the core package.


7zip uses a major.minor versioning scheme, whereas NPM uses a major.minor.patch versioning scheme. To reconcile this, the NPM packages will use the 7zip version as the major.minor version, and the patch version will be reserved for NPM package updates.

e.g. version 23.1.2 corresponds to 7zip version 23.01, and the second revision of the NPM package. To preserve SemVer compatibility, the patch version will be reset to 0 when the major or minor version is incremented, and I strive to only introduce breaking changes when bumping the major version.

If you want the very specific package version, use the save-exact flag when installing the package, or use the version lock syntax in your package.json:

npm i @8zip/bin@23.1.2 -E
yarn add @8zip/bin@23.1.2 -E
pnpm add @8zip/bin@23.1.2 -E
    "dependencies": {
        "@8zip/bin": "23.1.2"