> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hiverge.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Commands

> Complete reference for all Hivekit CLI commands, options, and environment variables.

## Global Options

All `hive` commands accept the following options:

```
hive [-h] <command>
```

## `hive init`

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

```
hive init [-h]
```

## `hive login`

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

```
hive login [-h]
```

## `hive logout`

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

```
hive logout [-h]
```

## `hive create experiment`

Create a new experiment from the configuration file.

**Aliases:** `hive create exp`

```
hive create experiment [-h] -c CONFIG [--dry-run] [overrides ...]
```

| Argument / Option | Description                                                                            |
| ----------------- | -------------------------------------------------------------------------------------- |
| `--config`, `-c`  | Path to the experiment config file (required)                                          |
| `--dry-run`       | Validate the config and CLI invocation without creating the experiment                 |
| `overrides`       | Zero or more `key=value` dot-notation overrides applied on top of the YAML (see below) |

Overrides let you tweak config values without editing the file:

```
hive create exp -c hive.yaml \
  experiment_name=foo- \
  repo.branch=feature/try-hive \
  sandbox.resources.cpu=1
```

Use `~key.path` to delete a key (restoring the Pydantic field default):

```
hive create exp -c hive.yaml ~prompt.context
```

## `hive list experiments`

List all experiments for the current organisation.

**Aliases:** `hive list exp`, `hive list exps`

```
hive list experiments [-h]
```

## `hive list coordinators`

List coordinator configurations.

**Aliases:** `hive list coords`

```
hive list coordinators [-h]
```

## `hive list image`

List pushed sandbox images.

**Aliases:** `hive list images`

```
hive list image [-h]
```

## `hive get experiment`

Get detailed information about a specific experiment.

**Aliases:** `hive get exp`

```
hive get experiment [-h] <name>
```

| Argument / Option | Description            |
| ----------------- | ---------------------- |
| `name`            | Name of the experiment |

## `hive get config`

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

```
hive get config [-h] <name>
```

| Argument / Option | Description            |
| ----------------- | ---------------------- |
| `name`            | Name of the experiment |

## `hive stop experiment`

Stop one or more running experiments.

**Aliases:** `hive stop exp`

```
hive stop experiment [-h] [-y] <name> [name ...]
```

| Argument / Option | Description                                                                     |
| ----------------- | ------------------------------------------------------------------------------- |
| `name`            | Name(s) of the experiment(s) to stop                                            |
| `--yes`, `-y`     | Skip confirmation prompt (only prompted when stopping more than one experiment) |

## `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 logs [-h] [--source {all,coordinator,sandbox}] [--worker WORKER] [--no-follow] <name>
```

| Argument / Option | Description                                                                                  |
| ----------------- | -------------------------------------------------------------------------------------------- |
| `name`            | Name of the experiment                                                                       |
| `--source`        | Log source: `all`, `coordinator`, or `sandbox` (default: `all` — coordinator + sandbox 0)    |
| `--worker`        | Sandbox worker index (0-based, default: `0`) or `all`. Not valid with `--source=coordinator` |
| `--no-follow`     | Print existing logs without following                                                        |

```
# Follow both coordinator and sandbox 0 (the default)
hive logs my-experiment-abc123

# Print the existing logs for sandbox worker 0 and exit
hive logs my-experiment-abc123 --source sandbox --worker 0 --no-follow
```

## `hive push image`

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

```
hive push image [-h] [--sync-config CONFIG] <local> <remote>
```

| Argument / Option | Description                                                                                                                                       |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `local`           | Local image reference to push (e.g. `myapp:dev`)                                                                                                  |
| `remote`          | Remote image reference in `hive:{short}:{tag}` form (e.g. `hive:myapp:latest`)                                                                    |
| `--sync-config`   | After pushing, pin `sandbox.base_image` in `CONFIG` to the pushed image's digest (`hive:{short}:{tag}@{digest}`), preserving the rest of the file |

```
# Build locally, then push to the Hive registry
docker build -t myapp:dev .
hive push image myapp:dev hive:myapp:latest

# Push and pin the resulting digest into your config
hive push image myapp:dev hive:myapp:latest --sync-config hive.yaml
```

## `hive delete image`

Delete a pushed sandbox image.

**Aliases:** `hive delete images`

```
hive delete image [-h] [--all] <image>
```

| Argument / Option | Description                                                 |
| ----------------- | ----------------------------------------------------------- |
| `image`           | Image to delete as `{name}:{tag}`, or `{name}` with `--all` |
| `--all`           | Delete every version of `{name}`                            |

## `hive dashboard`

Open the Hive dashboard in a browser window.

```
hive dashboard [-h] [--no-browser]
```

| Option         | Description                                                 |
| -------------- | ----------------------------------------------------------- |
| `--no-browser` | Print the dashboard URL to stdout without opening a browser |