Skip to content

Lua API Archive

Leonard Ramminger edited this page Aug 10, 2026 · 1 revision

Lua API — Archive (beez.archive)

Create and read zip/tar archives (libarchive).

Formats

zip, tar, tar.gz, tar.bz2, tar.xz (by extension or format option).

Functions

Function Returns
compress(src, archive, [options]) { path, bytes }
extract(archive, dest_dir) { entries, dest }
list(archive) { { path, size, is_dir }, ... }
extract_file(archive, entry, dest) { path, bytes }
read_text(archive, entry) string (max 16 MiB)
beez.archive.compress("dist", "release.zip")
local version = beez.archive.read_text("release.zip", "VERSION")

← Lua API Overview

Clone this wiki locally