`papyri.cli.pack:pack`

source: /papyri/cli/pack.py :13

Signature

   def     pack (    bundle_dir  :  Annotated[Path | None, typer.Argument(help='Path to a DocBundle directory (output of `papyri gen`). If omitted, pack every bundle under ~/.papyri/data/.')]    =  None   ,    output  :  Annotated[Path | None, typer.Option('--output', '-o', help="Output file path or directory (single-bundle mode only). If a directory, '<module>-<version>.papyri' is appended. Default: '<module>-<version>.papyri' next to each bundle directory (under ~/.papyri/data/ in bulk mode, or in the current directory in single-bundle mode).")]    =  None   ,    verbose  :  Annotated[bool, typer.Option('--verbose', '-v', help='Show per-step packing progress (layout check, per-directory item counts, encode/compress sizes).')]    =  False     )   →  None

Summary

Validate a DocBundle directory and write a single deterministic .papyri artifact (gzipped canonical-CBOR Bundle Node).

Extended Summary

Running pack twice on the same input produces byte-identical output.

Bulk mode: if no bundle_dir is given, every directory under ~/.papyri/data/ is packed in turn and the artifacts are written alongside them.

Aliases

papyri.pack