Various Documentation

UPack Reference Guide

upack.exe is a standalone command-line tool to aide in the creation of universal packages, and is typically used on build servers or in other automation scenarios.

Installation

The latest UPack is available from here as a zip file, or as a package on chocolatey.org. To install the chocolatey package, simply type choco install upack.

Source Code

UPack is open-source on GitHub: https://github.com/Inedo/upack

Usage

UPack is invoked as follows:

upack «command»

The command is one of the following:

  • pack - Creates a new ProGet universal package using specified metadata and source directory.
  • push - Pushes a ProGet universal package to the specified ProGet feed.
  • unpack - Extracts the contents of a ProGet universal package to a directory.
  • install - Downloads the specified ProGet universal package and extracts its contents to a directory.
  • list - Lists packages installed in the local registry.

Pack

upack pack «source» [--metadata=«metadata»] [--targetDirectory=«targetDirectory»] [--group=«group»] [--name=«name»] [--version=«version»] [--title=«title»] [--description=«description»] [--icon=«icon»]

  • source - Directory containing files to add to the package.
  • metadata - Path of a valid upack.json metadata file.
  • targetDirectory - Directory where the .upack file will be created. If not specified, the current working directory is used.
  • group - Package group. If metadata file is provided, value will be ignored.
  • name - Package name. If metadata file is provided, value will be ignored.
  • version - Package version. If metadata file is provided, value will be ignored.
  • title - Package title. If metadata file is provided, value will be ignored.
  • description - Package description. If metadata file is provided, value will be ignored.
  • icon - Icon absolute Url. If metadata file is provided, value will be ignored.

Push

upack push «package» «target» [--user=«authentication»]

  • package - Path of a valid .upack file.
  • target - URL of a upack API endpoint.
  • user - User name and password to use for servers that require authentication. Example: username:password

Unpack

upack unpack «package» «target» [--overwrite]

  • package - Path of a valid .upack file.
  • target - Directory where the contents of the package will be extracted.
  • overwrite - When specified, overwrite files in the target directory.

Install

upack install «package» [«version»] --source=«source» --target=«target» [--user=«user»] [--comment=«comment»] [--overwrite] [--prerelease] [--userregistry] [--unregistered] [--cache]

  • package - Package name and group, such as group/name.
  • version - Package version. If not specified, the latest version is retrieved.
  • source - URL of a upack API endpoint.
  • target - Directory where the contents of the package will be extracted.
  • user - User name and password to use for servers that require authentication. Example: username:password
  • overwrite - When specified, Overwrite files in the target directory.
  • prerelease - When version is not specified, will install the latest prerelase version instead of the latest stable version.
  • comment - The reason for installing the package, for the local registry.
  • userregistry - Register the package in the user registry instead of the machine registry.
  • unregistered - Do not register the package in a local registry.
  • cache - Cache the contents of the package in the local registry.

List

upack list [--userregistry]

  • userregistry - List packages in the user registry instead of the machine registry.