`papyri.cli.unpack:unpack`

source: /papyri/cli/unpack.py :11

Signature

   def     unpack (    artifact  :  Annotated[Path, typer.Argument(help='Path to a `.papyri` artifact (output of `papyri pack`).')]    ,    output  :  Annotated[Path | None, typer.Option('--output', '-o', help="Parent directory in which to create the bundle directory. The directory is always named '<module>_<version>'. Default: the current directory.")]    =  None   ,    verbose  :  Annotated[bool, typer.Option('--verbose', '-v', help='Show per-step unpacking progress.')]    =  False     )   →  None

Summary

Decode a .papyri artifact and write its contents out as a human-readable JSON DocBundle directory (the same layout papyri gen produces: papyri.json, toc.json, module/, docs/, examples/, assets/).

Extended Summary

The bundle directory is named <module>_<version> and created under the output directory (the current directory by default). The command fails if that directory already exists.

Aliases

papyri.unpack