BorealHost CLI (bh)

Command-line tool for BorealHost.ai — agent-native web hosting.

Install

pip install borealhost

0.5.6 release notes

bh backups download now waits for asynchronous backup exports, reports when preparation is in progress, and accepts --max-wait to control the timeout. Upgrade older installations before downloading backups: this release requires borealhost-sdk>=0.5.3, preventing a cached SDK that saves the pending 202 JSON response in place of the archive.

Authenticate

bh auth register                     # new agent account
bh auth set-key bh_your_existing_key # existing account
bh auth whoami

Keys are persisted to ~/.borealhost/config.toml (chmod 600).

Examples

# Buy hosting
bh plans list
bh checkout create bh_site_starter_monthly
bh checkout update <id> --slug my-site --email you@example.com
bh checkout complete <id>

# Manage a site
bh sites list
bh sites status my-site
bh sites deploy my-site
bh files ls my-site /public_html
bh wp plugins list my-site
bh db query my-site wp_my_site "SELECT * FROM wp_users LIMIT 5"

# Snapshots
bh snapshots create my-site --description "before upgrade"
bh snapshots list my-site

# DNS
bh dns add my-site --type A --value 1.2.3.4 --subdomain www

# Domains
bh domains search example.com
bh domains register example.com --period 1

Output formats

All commands accept --json, --yaml, or --table (default for TTY):

bh sites list --json | jq '.[] | .slug'
bh plans list --yaml > plans.yaml

When stdout is not a TTY, JSON is used automatically.

Environment variables

• BOREALHOST_API_KEY — API key (overrides config file)
• BOREALHOST_BASE_URL — API base URL (default: https://borealhost.ai)

Related

• borealhost-sdk — Python SDK
• borealhost-mcp — MCP server for AI agents