ProGet 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.

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.

Pack

upack pack «metadata» «source» [--targetDirectory=«targetDirectory»]

  • metadata - Path of a valid upack.json metadata file.
  • source - Directory containing files to add to the package.
  • targetDirectory - Directory where the .upack file will be created. If not specified, the current working directory is used.

Push

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

  • package - Path of a valid .upack file.
  • target - URL of a upack API endpoint.
  • authentication - 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.
Usage: upack [] [version] [options] Arguments: --packageName=[value] --version=[value] --source=[value] --target=[value] --user=[value] User name and password to use for servers that require authentication. Example: --user=username:password --overwrite Overwrite files in the target directory.

Install

upack install «package» [«version»] --source=«sourceUrl» --target=«targetDirectory» [--user=«authentication»] [--overwrite]

  • packageName - Package name and group, such as group:name
  • version - Package version. If not specified, the latest version is retrieved.
  • sourceUrl - URL of a upack API endpoint.
  • targetDirectory - Directory where the contents of the package will be extracted.
  • authentication - User name and password to use for servers that require authentication. Example: username:password
  • overwrite - When specified, Overwrite files in the target directory.