# DeployHQ CLI — Agent Skill Guide ## Identity DeployHQ is a deployment automation platform. The `deployhq` CLI manages projects, servers, and deployments. ## Authentication Set `DEPLOYHQ_API_TOKEN` environment variable, or run `dhq auth login`. ## Quick Reference ### Discovery ``` dhq commands --json # Full command catalog dhq --help # Usage overview dhq --help # Command details ``` ### Common Workflows #### List projects ``` dhq projects list --json ``` #### Deploy latest to a server ``` dhq deploy -p -s --use-latest --json ``` #### Check deployment status ``` dhq deployments show -p --json ``` #### View deployment logs ``` dhq deployments logs -p ``` #### Rollback ``` dhq rollback -p --json ``` #### Escape hatch (any API endpoint) ``` dhq api GET /projects//environment_variables dhq api POST /projects//config_files --body '{"config_file":{...}}' ``` ## Decision Tree ### "Deploy code" 1. `dhq projects list --json` → find project 2. `dhq servers list -p --json` → find server 3. `dhq deploy -p -s --json` → create deployment 4. `dhq deployments show -p --json` → check status ### "Check what's deployed" 1. `dhq deployments list -p --json` → recent deployments 2. `dhq deployments show -p --json` → details + steps ### "Something went wrong" 1. `dhq deployments logs -p ` → read logs 2. `dhq rollback -p --json` → rollback if needed 3. `dhq deployments abort -p ` → abort if running ## Invariants - Always use `--json` for machine-readable output - JSON responses include `breadcrumbs` with suggested next commands - Exit code 0 = success, 1 = failure (check JSON `ok` field for details) - Empty results return exit 0 with empty `data` (not an error) - `dhq api` covers any endpoint not in the command tree ## Triggers - User mentions "deploy", "deployment", "release" → deployment workflow - User mentions "server", "hosting" → server management - User mentions "rollback", "revert" → rollback workflow - User mentions "DeployHQ", "deployhq" → general CLI usage

DeployHQ CLI — Agent Skill Guide

Install this skill

Comments