DesktopHub Documentation

Inedo Hub CLI

  • Last Modified: 2019-04-10

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:

NameDescription
TargetDirectoryThe root install directory for ProGet.

Default value:
$PathCombine($SpecialWindowsPath(ProgramFiles), ProGet)
ConnectionStringConnection string used to create and initialize the database schema.

no default value
UseIntegratedWebServerWhen true, installs a service to host the integrated web server.

default value: true
UseIISWhen true, creates an app pool and site in IIS.

default value: false
DbNameName of the SQL database to use or create. This overrides any Initial Catalog specified in the connection string.

default value: ProGet
WebServerPrefixesSpecifies the URL which is used by the integrated web server. Ignored if UseIntegratedWebServer is not true.

default value: http://*:8624/
ExtensionsPathSpecifies the directory where user-installed product extensions will be stored.

default value: $PathCombine($SpecialWindowsPath(CommonApplicationData), ProGet, Extensions)
ExtensionsTempPathSpecifies the directory where extensions are unpacked and loaded from.

default value: $PathCombine($SpecialWindowsPath(CommonApplicationData), ProGet, ExtensionsTemp)
LicenseKeyIf specified, this license key will be written to the database instance on installation.

no default value
UserAccountThe 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.

default value: NetworkService
IsUpgradeWhen true, services and IIS settings will not be created.

default value: false
RemoveLegacyComponentsRemoves legacy installations created before the Inedo Hub was available. (Versions of ProGet before 5.1.0).

default value: false
EncryptionKey32-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.

default value: $CryptoRandomBytes(16)

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.

Is this documentation incorrect or incomplete? Help us by contributing!

This documentation is licensed under CC-BY-SA-4.0 and stored in GitHub.