Command Line Options

Jump to Section

Intelligence Hub can be launched with several command line arguments. Below is a list of the available arguments along with their arguments.

Option	Arguments	Description
`start`	N/A	Start the Intelligence Hub runtime.
`stop`	N/A	Stop the Intelligence Hub runtime.
`version`	N/A	Print the Intelligence Hub version.
`export`	`[file_path]`	Export the deployment JSON to the specified file. If no file path is specified, the file will be exported as `intelligencehub-deployment.json`
`encrypt`	`<file_path>`	Encrypt secrets in the provided JSON file.
`set-password`	`<new_password>`	Set the password for the keystore.
`rotate-password`	`<current_password> <new_password>`	Rotate the password for the keystore.

Usage

start

bash

java -jar intelligencehub.jar start

stop

bash

java -jar intelligencehub.jar stop

version

bash

java -jar intelligencehub.jar version

export

Exports the deployment file intended to be used for the Git Deployment Integration.

bash

java -jar intelligencehub.jar export my_export.json

encrypt

bash

java -jar intelligencehub.jar encrypt my_encrypted.json

set-password

A password for the Intelligence Hub Key store file can be set one of three ways:

Option 1: As clear text directly in the command line.

bash

java -jar intelligencehub.jar set-password my_password

Option 2: As an environment variable, where the environment variable name is prefixed with env:.

bash

java -jar intelligencehub.jar set-password env:MY_PASSWORD_ENV_VAR

Option 3: Interactively via the console. This is achieved by not passing a password as part of the command line.

bash

java -jar intelligencehub.jar set-password

set-password can only be used once to change the password used to encrypt the certificate store file. After set-password is run, the environment variable HIGHBYTE_STORE_PASSWORD must be set. It should be equal to your new password.

To change the password, see rotate-password

rotate-password

A password for the Intelligence Hub Key Store can be rotated one of three ways:

Option 1: As clear text directly in the command line.

bash

java -jar intelligencehub.jar rotate-password my_current_password my_new_password

Option 2: As environment variables, where the environment variable name is prefixed with env:.

bash

java -jar intelligencehub.jar rotate-password env:MY_CURRENT_PASSWORD_ENV_VAR env:MY_NEW_PASSWORD_ENV_VAR

Option 3: Interactively via the console. This is achieved by not passing the passwords as part of the command line.

bash

java -jar intelligencehub.jar rotate-password

rotate-password can only be run after the default password is changed using set-password. After rotate-password is run, the environment variable HIGHBYTE_STORE_PASSWORD must be set. It should be equal to your new password.

Git Deployment Integration