Hectiq Lab

Authenticate

Most calls need an API key. The command line makes one for you:

hlab login

It asks for the email and password you use on the web app, then saves a key for this machine in ~/.hectiq-lab/credentials.toml. The password is sent once and never kept.

OptionDescription
--emailYour email, instead of being asked for it.
--nameWhat to call the key. The machine's name otherwise.
--jsonPrint the result as JSON.

Without the command line

On a machine where only hectiqlab is installed, set the key in the environment:

export HECTIQLAB_API_KEY=...

Where the key is read from

The first that has a key wins:

  1. HECTIQLAB_API_KEY.
  2. The table of the credentials file that HECTIQLAB_PROFILE names.
  3. The first table of the credentials file that holds a key.

The credentials file is ~/.hectiq-lab/credentials.toml, or the path in HECTIQLAB_CREDENTIALS. pyhectiqlab reads the same file.

On this page