@epubknowledge/zippy

Zip and unzip CLI and library for EPUB containers

Install

npm:

npm i @epubknowledge/zippy

pnpm:

pnpm add @epubknowledge/zippy

yarn:

yarn add @epubknowledge/zippy

To use the package locally before publishing to a registry, npm link (or the pnpm/yarn equivalent) symlinks the package instead of installing from a registry. Note this skips the files/bin packaging logic, so re-test with npm pack before publishing.

npm:

npm link
cd /path/to/consuming-project
npm link @epubknowledge/zippy
zippy --help

pnpm:

cd /path/to/consuming-project
pnpm link /path/to/@epubknowledge/zippy
zippy --help

yarn:

yarn link
cd /path/to/consuming-project
yarn link @epubknowledge/zippy
zippy --help

CLI

zippy zip <inputDir> [outputFile] [-d dir] [-n name] [-o]
zippy unzip <inputFile> [outputDir] [-d dir] [-n name] [-o]

Note

npx zippy will not run this package. The zippy name resolves to a different public package on npm, so install @epubknowledge/zippy and run the zippy binary directly as shown above.

See docs/cli.md for details.

Library

import { zip } from '@epubknowledge/zippy/zip'
import { unzip } from '@epubknowledge/zippy/unzip'

• docs/zip.md
• docs/unzip.md

Development

yarn install
yarn test
yarn run build