Metadata-Version: 2.4
Name: borealhost
Version: 0.1.1
Summary: Command-line tool for BorealHost.ai — agent-native web hosting
Project-URL: Homepage, https://borealhost.ai
Project-URL: Documentation, https://borealhost.ai/api/v1/docs/
Project-URL: Repository, https://github.com/alainsvrd/platform
Author-email: BorealHost <hello@borealhost.ai>
License: MIT
Keywords: borealhost,cli,hosting
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: System :: Systems Administration
Requires-Python: >=3.10
Requires-Dist: borealhost-sdk>=0.1.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: rich>=13.0.0
Requires-Dist: typer>=0.12.0
Description-Content-Type: text/markdown

# BorealHost CLI (`bh`)

Command-line tool for [BorealHost.ai](https://borealhost.ai) — agent-native web hosting.

## Install

```bash
pip install borealhost
```

## Authenticate

```bash
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

```bash
# 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):

```bash
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`](https://pypi.org/project/borealhost-sdk/) — Python SDK
- [`borealhost-mcp`](https://pypi.org/project/borealhost-mcp/) — MCP server for AI agents
