Skip to main content

Documentation Index

Fetch the complete documentation index at: https://filepacks.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

The current public CLI is intentionally narrow. Supported commands: 
filepacks pack <input> --output <file>
filepacks inspect <file>
filepacks verify <file>
filepacks compare <baseline> <candidate>
Unsupported commands are not part of the public OSS surface, including show, import, registry, list, tag, baseline, unpack, and config.

​
Choose the right command

If you want to…Run
package a directory as one artifactfilepacks pack <input> --output <file>
read the artifact summaryfilepacks inspect <file>
confirm the artifact is intactfilepacks verify <file>
see whether packaged files changedfilepacks compare <baseline> <candidate>

​
Global help

filepacks --help
For a clean-shell trial, use: 
npx filepacks --help
Command-specific help is also available: 
filepacks pack --help
filepacks inspect --help
filepacks verify --help
filepacks compare --help

​
Command behavior summary

CommandWhat it doesExit behavior
packCreate a deterministic .fpk artifact from a directory0 on success, 1 on usage or file errors
inspectRead artifact metadata from a .fpk file0 on success, 1 on usage or file errors
verifyCheck payload files against the manifest0 when valid, 1 when invalid or on usage/file errors
compareStructurally compare two artifacts0 when identical, 20 when different, 1 on usage/file errors

​
Output style

The CLI uses line-oriented plain text output rather than JSON. That makes it easy to read in a terminal and easy to consume from shell scripts. Examples:
  • pack prints input=, output=, name=, digest=, files=, bytes=
  • inspect prints path=, name=, version=, digest=, files=, bytes=
  • verify prints ok=true or ok=false
  • compare prints ok=, summary counts, and per-file change lines
Most users start here:
  1. pack the output directory.
  2. inspect the resulting artifact.
  3. verify it before trusting or sharing it.
  4. compare it against a baseline when you care about repeated-run drift.
Use CLI workflows for end-to-end patterns.

​
Core library mapping

The CLI is a conservative wrapper around @filepacks/core:
  • CLI pack -> pack()
  • CLI inspect -> inspect()
  • CLI verify -> verify()
  • CLI compare -> compare()
Use the core package when you need structured results in code.