Skip to main content

Global Options

All hive commands accept the following options:

hive init

Initialize the Hive configuration. Prompts for your organisation ID and writes it to ~/.hive/config.yaml.

hive login

Log in to the Hive platform. Opens a browser for authentication and prints the login URL to the terminal.

hive logout

Log out and clear stored credentials for the currently configured organisation.

hive create experiment

Create a new experiment from the configuration file. Aliases: hive create exp
Overrides let you tweak config values without editing the file:
Use ~key.path to delete a key (restoring the Pydantic field default):

hive list experiments

List all experiments for the current organisation. Aliases: hive list exp, hive list exps

hive list coordinators

List coordinator configurations. Aliases: hive list coords

hive list image

List pushed sandbox images. Aliases: hive list images

hive get experiment

Get detailed information about a specific experiment. Aliases: hive get exp

hive get config

Get the stored config (hive.yaml + command line) for an experiment.

hive stop experiment

Stop one or more running experiments. Aliases: hive stop exp

hive logs

Stream logs for an experiment. By default the logs are followed live; pass --no-follow to print the existing logs and exit.

hive push image

Push a locally-built Docker image to the Hive registry so it can be referenced as a sandbox.base_image.

hive delete image

Delete a pushed sandbox image. Aliases: hive delete images

hive dashboard

Open the Hive dashboard in a browser window.