Skip to main content

​
Prerequisites

  • Python 3.12+
  • A Hiverge account (contact your organisation administrator for help)

​
Installation

Install the hivekit CLI from PyPI: 
pip install hivekit
Verify the installation: 
hive --help

​
Initialization

Initialize hivekit by running: 
hive init
You will be prompted for your organisation ID. This creates a config file at ~/.hive/config.yaml which stores per-user settings (e.g. organization_id).

​
Authentication

Authenticate with the Hive platform: 
hive login
This opens a browser window for authentication and prints the login URL to the terminal (useful for headless or remote environments). You may not be prompted to log in if there is already an active session. On successful login, you will see a confirmation screen and can return to the command line. To clear stored credentials: 
hive logout

​
Next steps

Configure an experiment

Set up your configuration YAML to define how experiments run.