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.

​
What it does

inspect reads an artifact and prints a compact summary derived from its manifest. Use it when you want a quick read on what an artifact claims to contain before deciding whether to verify or compare it.

​
Usage

filepacks inspect <file>

​
When to use it

  • after pack to confirm the resulting artifact
  • when someone hands you a .fpk file
  • before verify or compare, when you want to confirm name, version, digest, size, and file count

​
Arguments

  • <file>: path to an existing .fpk artifact
The current CLI requires the path to end in .fpk.

​
Minimal example

npx filepacks inspect ./artifact.fpk

​
Expected output shape

Example output: 
Inspect
path=/absolute/path/to/artifact.fpk
name=artifact
version=1
digest=sha256:...
files=2
bytes=12

​
What it tells you

  • artifact path
  • artifact name
  • manifest format version
  • archive digest
  • file count
  • total bytes

​
Common mistakes

  • using inspect when you actually need integrity guarantees; use verify for that
  • passing a path that does not end in .fpk
  • assuming the CLI prints the full per-file list; the summary is intentionally compact
  • pack to create the artifact
  • verify to confirm the payload still matches the manifest
  • compare to see whether another artifact differs

​
Core API

const artifact = await inspect({artifact: '/tmp/example.fpk'})

artifact.manifest.artifact_name
artifact.manifest.files
artifact.payloadFiles
artifact.artifactDigest