ark is a crash-safe archive and compression tool for Linux and OpenBSD. It
creates .ark files with integrated Deflate compression, per-member hashes, an
index hash, sandboxed operations, and atomic writes via vendored
libchevron.
ark is a command-line tool, not a library, and it does not read or write
tar, zip, or other existing archive formats.
- Single
.arkarchive format with built-in Deflate compression - Per-member and index integrity verification
- Parallel create, extract and verify using fixed 1MB chunks; all three keep chunks of several files in flight, so trees of small files compress and decompress in parallel too
- Crash-safe archive writes via vendored libchevron
- Mandatory sandboxing: Landlock and a seccomp-bpf system call filter per
subcommand on Linux,
pledge(2)andunveil(2)on OpenBSD - Standalone recovery reader generation for long-term archive recovery
- Linux 5.13+ or OpenBSD 6.4+
- x86_64 or ARM64 (on Linux the build stops on any other architecture)
- glibc on Linux (musl is untested)
- C11 compiler
make- No external runtime dependencies beyond libc/pthread
- Vendored libchevron
Linux 5.13 is a hard minimum because Landlock sandboxing is mandatory. On Linux 5.13 through 5.18, extracting archives containing hardlinks is rejected before filesystem side effects because hardlink extraction requires Landlock ABI v2, available from Linux 5.19.
On Linux, every subcommand also runs under a seccomp-bpf allowlist of system
calls, the counterpart of its OpenBSD pledge(2) promises. The allowlists
exist for x86_64 and ARM64 only, so ark does not build for other Linux
architectures rather than run there without a tested filter. They were
derived and tested with glibc. A system call outside the list stops ark with
exit status 70 and a message naming the call number; please report it as a
bug.
make releaseThe binary is written to:
build/arkInstall the binary and manual page:
make installThe default prefix is /usr/local. Override it with:
make install PREFIX="$HOME/.local"Run the test suite:
make testCreate an archive:
ark create archive.ark pathThe default compression (Deflate level 6) favours small archives.
--fast uses level 1 instead: creating is roughly two to three times
faster, but the archive is about a tenth larger and somewhat slower to
extract. The archive format is the same either way.
ark create --fast archive.ark pathList archive contents:
ark list archive.arkVerify archive integrity:
ark verify archive.arkExtract into a directory:
ark extract --output restored archive.arkGenerate a standalone recovery reader:
ark generate-reader recovery.c
cc -O2 recovery.c -o recoverark generate-reader writes a self-contained C11 source file that can extract
v1 .ark archives without requiring ark itself. The intended preservation
workflow is to keep both files together:
archive.ark
recovery.c
If this repository disappears, or if ark is not installed many years later,
anyone with a C11 compiler on a POSIX system (POSIX.1-2008) can build the
recovery reader and extract the archive:
cc -O2 recovery.c -o recover
mkdir out && cd out && ../recover ../archive.arkThe generated file opens with a description of the whole format, enough to
recover the data by hand, and includes a Deflate decompressor, BLAKE3 and
SHA-256 implementations, archive read logic, and an extraction program. It
checks the archive exactly as ark does before writing anything (exit
status 2 if the archive is rejected), extracts into the current directory
without replacing existing files or following a symbolic link in a member's
path, restores mode and mtime, and needs memory for the archive index plus
about 2 MiB, whatever the archive size. If a member is damaged, recovery
stops there and keeps the members already recovered. See ARCHITECTURE.md
section 15 for the full recovery model.
[Fixed header] 16 bytes
[Member data] Deflate-compressed 1MB chunks
[Index] Member metadata, offsets, chunk sizes, hashes
[Footer] 64 bytes, contains index location and hash
All multi-byte fields are little-endian. The index is verified before
extraction touches the filesystem. See ARCHITECTURE.md for the full format
specification.
- Not compatible with tar, zip, or other archive formats
- No encryption
- No ACL, SELinux context, or extended attribute preservation
--overwriteis not rollback-safe- Index metadata is buffered in memory
- Compression is always enabled; there is no store-only mode
- Recovery readers are separate companion files and must be kept with archives
See ARCHITECTURE.md section 17 for the complete limitations list.
man/ark.1- command referenceARCHITECTURE.md- format and implementation specificationTECH_STACK.md- build and platform requirementsTESTING.md- validation strategyDEVELOPMENT.md- implementation history and milestones- libchevron - vendored
crash-safe write library used by
ark