Helix TeamHub User Guide (2020.1 Enterprise)

Login and Logout commands

This section describes the Helix TeamHub CLI commands used to login and logout of Helix TeamHub.

hth login or hth session create

Use one of the following commands to login to TeamHub. Both commands work in the same way and have the same flags:

  • hth login
  • hth session create

Flags

Flags Description
-i or --instance Specify the TeamHub instance URL to login to.
-c or --company Specify the TeamHub company ID to login to.
-u or --user Specify the TeamHub user ID to log in with.
-p or --password Specify the password for the user
--password-stdin Read the password from a pipe

When run inside a project directory

hth-cli uses instance and company names from the manifest file and looks for matching user short names from the global config file. Select a user from the list or input a user and enter the password.

When running outside of a project directory

  1. If Helix TeamHub instances are configured in the global config, hth-cli asks you to select one or provide an URL to the Helix TeamHub instance.
  2. If company names are configured in the global config, hth-cli asks you to select one or provide a company name.
  3. If users are configured in the global config, hth-cli asks you to select one or provide a username. Input the password.

hth logout or hth session delete

Use one of the following commands to logout of TeamHub. Both commands work in the same way and have the same flags:

  • hth logout
  • hth session delete

Flags

Flags Description
-i or --instance Specify the TeamHub instance URL to logout from.
-c or --company Specify the TeamHub company ID to logout from.
-u or --user Specify the TeamHub user ID to logout.