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

# CLI

> Every HeyBee workflow from your terminal, with stable JSON for scripts.

The CLI ships with the Python package:

```bash theme={null}
pip install heybee
heybee auth login        # opens your browser; or set HEYBEE_API_KEY
```

Browser credentials are stored in your operating system keychain and are never printed. `heybee auth logout` revokes the credential on HeyBee before removing it locally.

## Everyday commands

```bash theme={null}
# Create and inspect evaluations
heybee evaluation create --file evaluation.json
heybee evaluation show <evaluation-id>
heybee evaluation readiness <evaluation-id>

# Upload a JSON array of samples (local files or inline text)
heybee sample upload <evaluation-id> --file samples.json

# Create a voting link and watch progress
heybee link create <evaluation-id>
heybee evaluation monitor <evaluation-id>

# Read the decision and export the evidence
heybee result show <evaluation-id>
heybee result export <evaluation-id> --output evidence.zip
```

Add `--axis-key <criterion>` to `result show` or `result evidence` for a single criterion's decision. `heybee huggingface import`, `list`, and `status` drive dataset imports.

## Scripting

Add `--json` to any command for stable machine-readable output. Errors include an error code, HTTP status, and request ID. Pass `--idempotency-key` on writes you might retry, such as link creation or pause and resume, so a rerun never creates a duplicate.

The CLI follows the same plan, role, and quota rules as the app, and interactive use always confirms before anything destructive or paid.

## Environments

Use `--environment` outside production, or `--base-url` and `--app-url` together for a custom deployment. On headless machines, `heybee auth login --no-browser` prints the authorization URL instead of opening a browser; the callback only ever binds to a random port on `127.0.0.1`.