js-cfb/packages/cfb-cli/README.md
2020-07-09 02:20:52 -04:00

1.4 KiB

Container File Blobs

This CLI tool inspects and can manipulate supported files, leveraging the base cfb library.

Installation

It is preferable to install the library globally with npm:

$ npm install -g cfb-cli

The global installation adds a command cfb-cli which can work with files.

Usage

  • cfb file [names...] extracts the contents of the file. If additional names are supplied, only the listed files will be extracted.

  • cfb -l file lists the contained files (following unzip -l "short format")

  • cfb -r file attempts to repair by reading and re-writing the file. This fixes some issues with files generated by non-standard tools.

  • cfb -c file [files...] creates a new file containing the listed files. The default root entry name is Root Entry.

  • cfb -a file [files...] adds the listed files to the original file.

  • cfb -d file [files...] deletes the listed files from the original file.

License

Please consult the attached LICENSE file for details. All rights not explicitly granted by the Apache 2.0 license are reserved by the Original Author.

Credits

Special thanks to Garrett Luu for spinning off the command from the CFB module.

Analytics