Create & Deploy
Directory-based commands for creating environments:
hud init— Create new environmenthud deploy— Build remotely & deploy to platformhud dev— Local development (hot-reload via--watch)hud build— Local build for validation
Run & Evaluate
Target-based commands for using environments and agents:
hud analyze— Inspect capabilities (fast/live)hud debug— 5‑phase compliance testhud run— Execute (Python module/command/Docker)hud eval— Run agents on tasks/datasetshud rft— Fine-tune models (BETA, invite-only)
Installation
Commands
Create & Deploy
| Command | Input | Description | Example |
|---|---|---|---|
hud init | Directory | Create new environment | hud init my-env |
hud deploy | Directory | Build remotely & deploy to platform | hud deploy . |
hud link | Directory | Link to existing environment | hud link --id abc123 |
Local Development
| Command | Input | Description | Example |
|---|---|---|---|
hud dev | Directory | Development server (--watch for hot-reload) | hud dev . -w controller |
hud build | Directory | Build image locally (for validation) | hud build . --tag v1.0 |
Running Workflow
| Command | Input | Description | Example |
|---|---|---|---|
hud analyze | Image or config | Inspect tools & capabilities | hud analyze org/env |
hud debug | Image/dir/config | 5‑phase compliance test | hud debug my-env:latest |
hud run | Module/command/image | Execute server (local/remote) | hud run controller --reload |
hud eval | Tasks/dataset | Run agent on tasks | hud eval tasks.json claude |
hud rft | Tasks file | Fine-tune models (BETA, invite-only) | hud rft run tasks.json |
Other Commands
| Command | Description | Example |
|---|---|---|
hud get | Download HF dataset to tasks file | hud get hud-evals/2048-basic -o tasks.jsonl |
hud quickstart | Clone quickstart repo | hud quickstart |
hud cursor-list | List Cursor MCP servers | hud cursor-list |
hud version | Show CLI version | hud version |
hud clone | Clone any git repo (pretty output) | hud clone https://github.com/... |
hud set | Persist API keys to ~/.hud/.env | hud set HUD_API_KEY=... |
Complete Workflows
Creating & Deploying an Environment
Initialize
Create a new HUD environment with minimal boilerplate:Creates
Dockerfile, pyproject.toml, controller/ (MCP server), optional environment/ backend, tasks.json.Deploy
Deploy directly to the HUD platform:This builds your environment remotely on HUD’s infrastructure and deploys it. Or push to GitHub and connect on hud.ai for automatic rebuilds.
Local Development (Optional)
Use these commands when iterating on your environment locally before deploying:hud dev runs your local development server; add --watch (-w) to enable automatic reloads. hud build creates a local Docker image and generates hud.lock.yaml for validation.
Running an Environment
Common Usage
Docker Images
Arbitrary Commands (Python/Node/etc.)
Cursor Integration
Output Formats
Interactive (Default)
JSON
Markdown
CI/CD Example
Python Scripting
Exit Codes
| Code | Meaning | Description |
|---|---|---|
| 0 | Success | Command completed |
| 1 | General Error | Command failed |
| 2 | Usage Error | Invalid arguments |
| 3 | Connection Error | Failed to connect |
| 4 | Timeout | Operation timed out |
| 5 | Protocol Error | MCP violation |
Environment Variables
Next Steps
Create & Deploy
Init Command
Create new environments from scratch
Deploy Command
Build remotely and deploy to HUD platform
Local Development
Dev Command
Develop locally with optional hot-reload and interactive testing
Build Command
Build images locally for validation