Processor Unarchiver

Unarchiver

NOTE: This page is automatically generated by GitHub Actions when a new release is tagged.
Updates to the information on this page should be submitted as pull requests to the AutoPkg repository. Processors are located here.

Description

Archive decompressor for zip and common tar-compressed formats.

Input Variables

• archive_path:
  • required: False
  • description: Path to an archive. Defaults to contents of the 'pathname' variable, for example as is set by URLDownloader.
• destination_path:
  • required: False
  • description: Directory where archive will be unpacked, created if necessary. Defaults to RECIPE_CACHE_DIR/NAME.
• purge_destination:
  • required: False
  • description: Whether the contents of the destination directory will be removed before unpacking.
• archive_format:
  • required: False
  • description: The archive format. Currently supported: 'zip', 'tar_gzip', 'tar_bzip2', 'tar'. If omitted, the file extension is used to guess the format.
• USE_PYTHON_NATIVE_EXTRACTOR:
  • required: False
  • description: Controls whether or not Unarchiver extracts the archive with native Python code, or calls out to a platform specific utility. The default is determined on a platform specific basis. Currently, this means that on macOS platform utilities are used, and otherwise Python is used.
  • default: True

Output Variables