The Hyperglance CLI tool

The hg CLI tool comes preloaded with all of our latest AMI and VM images and can be used to manage the lifecycle of your Hyperglance deployment:

• Update Hyperglance
• Configure SAML SSO
• Viewing logs
• Creating backups
• Start/Stop/Restart the application
• Apply configuration changes (such as applying custom TLS certificates)

Run hg --help to view all available commands:

Hyperglance cli provides useful sysadmin related tooling for managing the Hyperglance deployment from the OS.

Usage:
  hg [command]

Available Commands:
  apply-config Apply a values.yaml to the Hyperglance deployment, either from the default path, or a custom path.
  auto-update  Enable or disable auto updating Hyperglance on a schedule
  backup       Includes various backup related commands for the kubernetes version of Hyperglance.
  completion   Generate the autocompletion script for the specified shell
  docker       Includes some basic tooling for our legacy docker based deployments.
  help         Help about any command
  info         Includes various information related commands.
  install      Includes Hyperglance installation commands
  logs         Get container logs
  migrate      Includes commands to perform migrations for the Hyperglance Marketplace images.
  net          Includes network based commands.
  pause        Pauses the RKE2 based Hyperglance deployment.
  psql         Access the psql cli within the Hyperglance pod directly.
  restart      Restart the Hyperglance stateful set.
  saml         Includes tooling to aid in saml setup for Hyperglance.
  shell        Includes tooling that allows for running commands within a selected container.
  status       Gets the Hyperglance pod status
  unpause      Unpauses the RKE2 based Hyperglance deployment.
  update-cli   Update this cli. Requires access to docker hub.
  upgrade      Upgrades the RKE2 based Hyperglance to the latest current version.
  users        Includes tooling for managing users on a RKE2 based deployment of Hyperglance.
  validate     Validate the local RKE2 based Hyperglance deployment for misconfigurations and generate a support bundle if required.
  version      Print the version number of this cli tool and the version of Hyperglance running on this system.

Flags:
  -h, --help     help for hg
  -t, --toggle   Help message for toggle

(Note: The command palette may be different between versions, run the hg --help  command to view an up to date list).

To update the CLI the latest version see our update instructions.