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
Sync & Evaluate
Task management and agent execution:
hud sync tasks— Sync local tasks to platformhud sync env— Link to a platform environmenthud eval— Run agents on tasks/datasetshud scenario— Test scenarios on a running server
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 sync env | Name | Link to existing environment | hud sync env my-env |
Sync & Manage Tasks
| Command | Input | Description | Example |
|---|---|---|---|
hud sync tasks | Taskset + source | Sync local tasks to platform | hud sync tasks my-taskset |
hud sync | (stored config) | Sync using .hud/config.json | hud sync |
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 |
hud scenario | Server URL | Test scenarios on running server | hud scenario list |
Run & Evaluate
| Command | Input | Description | Example |
|---|---|---|---|
hud eval | Tasks/dataset | Run agent on tasks | hud eval tasks.py claude |
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 rl | Tasks/taskset | Submit RL training jobs | hud rl run my-taskset -m <model-id> |
Other
| Command | Description | Example |
|---|---|---|
hud push | Push built image to registry | hud push . |
hud cancel | Cancel remote eval jobs | hud cancel <job_id> |
Utilities
| Command | Description | Example |
|---|---|---|
hud set | Persist API keys to ~/.hud/.env | hud set HUD_API_KEY=... |
hud models | List available inference models | hud models --json |
hud convert | Convert external task formats to HUD | hud convert ./tasks --from harbor |
hud version | Show CLI version | hud version |
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
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
Running Commands
Analyze Command
Inspect tools and capabilities
Debug Command
Test MCP protocol compliance