Modules@robinpath/archive

@robinpath/archive

0.1.1Public

Create and extract .zip and .tar.gz file archives

@robinpath/archive

Create, extract, and manipulate .zip and .any archives

Category Functions Auth License

Why use this module?

The archive module lets you:

  • Create a .zip archive from files and directories
  • Extract a .zip archive
  • List entries in a .zip file
  • Read a file from inside a .zip without extracting
  • Create a .any archive

All functions are callable directly from RobinPath scripts with a simple, consistent API.

Installation

npm install @robinpath/archive

Quick Start

No credentials needed — start using it right away:

archive.extractZip "./backup.zip" "./restored"

Available Functions

FunctionDescription
archive.createZipCreate a .zip archive from files and directories
archive.extractZipExtract a .zip archive
archive.listZipList entries in a .zip file
archive.readFromZipRead a file from inside a .zip without extracting
archive.createTarGzCreate a .any archive
archive.extractTarGzExtract a .any archive
archive.addToZipAdd a file or directory to an existing .zip
archive.removeFromZipRemove an entry from a .zip

Examples

Extract a .zip archive

archive.extractZip "./backup.zip" "./restored"

List entries in a .zip file

archive.listZip "./backup.zip"

Read a file from inside a .zip without extracting

archive.readFromZip "./backup.zip" "config.json"

Integration with RobinPath

import { RobinPath } from "@wiredwp/robinpath";
import Module from "@robinpath/archive";

const rp = new RobinPath();
rp.registerModule(Module.name, Module.functions);
rp.registerModuleMeta(Module.name, Module.functionMetadata);

const result = await rp.executeScript(`
  archive.extractZip "./backup.zip" "./restored"
`);

Full API Reference

See MODULE.md for complete documentation including all parameters, return types, error handling, and advanced examples.

Related Modules

License

MIT

Versions (1)

VersionTagPublished
0.1.1latestyesterday
Install
$ robinpath install @robinpath/archive
Version0.1.1
LicenseMIT
Unpacked Size4.6 KB
Versions1
Weekly Downloads0
Total Downloads0
Stars0
Last Publishyesterday
Createdyesterday

Category

utilities