ProGet Documentation

Inedo Hub CLI

  • Last Modified: 2018-05-01

Note: This software is currently in Beta; screenshots are coming soon.

Inedo Hub CLI

A separate console program (hub.exe) is included with the standard GUI desktop hub. This tool supports the following commands:

Install

Usage: hub.exe install <product>[:version] [--arg=value]...

Installs/upgrades the specified product (ProGet, BuildMaster, Otter, or Hedgehog). If [:version] is not specified, the latest stable version is used. The --arg=value items are used to pass variables to Romp, and are the same variables defined for the package.

Installation arguments:

Name Default Value Description
TargetDirectory $PathCombine($SpecialWindowsPath(ProgramFiles), ProGet) The root install directory for ProGet.
ConnectionString no default Connection string used to create and initialize the database schema.
UseIntegratedWebServer true When true, installs a service to host the integrated web server.
UseIIS false When true, creates an app pool and site in IIS.
DbName ProGet Name of the SQL database to use or create. This overrides any Initial Catalog specified in the connection string.
WebServerPrefixes http://*:8624/ Specifies the URL which is used by the integrated web server. Ignored if UseIntegratedWebServer is not true.
ExtensionsPath $PathCombine($SpecialWindowsPath(CommonApplicationData), ProGet, Extensions) Specifies the directory where user-installed product extensions will be stored.
ExtensionsTempPath $PathCombine($SpecialWindowsPath(CommonApplicationData), ProGet, ExtensionsTemp) Specifies the directory where extensions are unpacked and loaded from.
LicenseKey no default If specified, this license key will be written to the database instance on installation.
UserAccount NetworkService The name of the user account which will be used to run ProGet's services and/or IIS AppPool. It may be LocalSystem, NetworkService, or any domain/local account.
IsUpgrade false When true, services and IIS settings will not be created.
RemoveLegacyComponents false Removes legacy installations created before the Inedo Hub was available. (Versions of ProGet before 5.1.0).
EncryptionKey $CryptoRandomBytes(16) 32-character hex string of encryption key for stored secrets. This value will be written to the product's configuration file on install only if there is not already an encryption key stored in the file.

Installation Examples

hub.exe install ProGet:5.1.0 --ConnectionString="Data Source=localhost; Integrated Security=True;"

Uninstall

Usage: hub.exe uninstall <product>

Uninstalls the specified product.

List

Usage: hub.exe list

Lists the versions of each package installed, as well as the latest available versions of all products in the configured feed.

Romp

Usage: hub.exe romp <arguments for romp>

Executes the Hub Romp instance and forwards any following arguments. This is useful primarily for troubleshooting failed installs using the romp jobs logs command.

Help

Usage: hub.exe help [command]

Displays help for this tool generally or any specific command.

Have a question? Try the Q&A Forum

Our documentation is now Open Source and on GitHub. We highly encourage our users to contribute and get involved! .