Skip to content
Last updated July 2, 2026

CLI

The hostatlas CLI is a single static Go binary that gives you scripting-friendly access to everything the dashboard does. It runs on macOS, Linux, and Windows, with shell completion for bash, zsh, fish, and PowerShell.

Terminal window
brew tap akyroslabs/hostatlas
brew install hostatlas
PlatformFile
macOS (Apple Silicon)hostatlas-darwin-arm64
macOS (Intel)hostatlas-darwin-amd64
Linux (x86_64)hostatlas-linux-amd64
Linux (ARM64)hostatlas-linux-arm64
Windowshostatlas-windows-amd64.exe

The top-level https://install.hostatlas.app/cli/version.json carries the full list under binaries[] (filename, size, sha256, url) — useful when scripting a version-pinned install.

Once installed, self-update from wherever it lives:

Terminal window
hostatlas update
Terminal window
hostatlas login --url https://my.hostatlas.app --key ha_your_api_key

Get the key from Settings → API Keys in your HostAtlas dashboard. The CLI stores it at ~/.hostatlas/cli.json with mode 0600. Revoke the key anytime — the CLI will fail loudly on next use.

CommandDescription
hostatlas loginConfigure API connection
hostatlas statusInfrastructure overview (servers, alerts, incidents, monitors)
hostatlas dashboardInteractive live TUI dashboard
hostatlas updateUpdate the CLI to the latest release
CommandDescription
hostatlas serversList all servers with status and health score
hostatlas server [uuid]Server detail with services and metrics
hostatlas server-addGenerate an install command for a new server
hostatlas restart [service] [server-uuid]Restart a service remotely
hostatlas ssh [server-uuid]Generate an SSH deep link (opens in the SSH Client)
hostatlas audit [server-uuid]Run a 7-day service audit
hostatlas network [server-uuid] [target]Network diagnostics (ping, traceroute, mtr, dig)
CommandDescription
hostatlas containersList all Docker containers across the fleet
hostatlas containers -s [server-uuid]Filter by server
hostatlas container-action [uuid] [start|stop|restart]Manage a container
CommandDescription
hostatlas domainsList all domains with SSL status
hostatlas certsList SSL certificates with expiry
hostatlas renew-cert [uuid]Trigger a certificate renewal
CommandDescription
hostatlas databasesList database servers (MySQL/PostgreSQL/Redis)
hostatlas database [server-uuid]Database metrics and config detail
CommandDescription
hostatlas alertsList active alert events
hostatlas ack [uuid]Acknowledge a firing alert
hostatlas alert-rulesList configured alert rules
hostatlas incidentsList open incidents
hostatlas monitorsList uptime monitors
hostatlas heartbeatsList heartbeat monitors
CommandDescription
hostatlas recipesList available recipes / scripts
hostatlas run-recipe [recipe-uuid] [server-uuid]Execute a recipe on a server
hostatlas cron-jobsList cron jobs
hostatlas cron-jobs -s [server-uuid]Filter cron jobs by server
hostatlas maintenanceList maintenance windows
hostatlas maintenance-create [title] [start] [end]Create a maintenance window
CommandDescription
hostatlas backups [server-uuid]List backup watch paths on a server
hostatlas backup-add [server-uuid] [path]Add a backup path to monitor
hostatlas backup-remove [server-uuid] [path]Remove a backup path
hostatlas offsite-backupsList offsite backups
hostatlas offsite-restore [backup-uuid] [server-uuid]Trigger an offsite restore
hostatlas offsite-keyShow encryption key info
CommandDescription
hostatlas config-diffsList recent configuration changes
hostatlas queuesList queue monitoring data (from queue-monitor)
hostatlas deploysList recent deployments
hostatlas export [servers|domains|incidents|events]Export data as JSON
CommandDescription
hostatlas attack [server-uuid]Check Attack Mode status
hostatlas attack [server-uuid] --onActivate Attack Mode
hostatlas attack [server-uuid] --offDeactivate Attack Mode
CommandDescription
hostatlas onboardBulk-install the HostAtlas agent from ~/.ssh/config + /etc/hosts (see below)

hostatlas dashboard opens a full-screen TUI with live-updating data:

  • Overview tab: KPI cards (servers / alerts / incidents / monitors), offline servers, firing alerts
  • Servers tab: All servers with health scores and status
  • Alerts tab: Active alert events with severity and target

Keyboard shortcuts: 1-3 switch tabs, r refresh, q quit. Auto-refreshes every 10 seconds.

Reads ~/.ssh/config and /etc/hosts as two independent import sources, presents a checkbox picker of usable hosts, then SSHes to each selected host via the local ssh binary and installs the agent. Every host gets a fresh install key minted from the platform — one per server, revocable individually.

  • Honours your IdentityFile, ProxyJump, ControlMaster, and ssh-agent — nothing about SSH is re-implemented
  • Auto-skips wildcards + github.com / gitlab.com / bitbucket.org from ssh_config; auto-skips loopback / multicast / link-local / broadcasthost from /etc/hosts
  • Picker rows carry a [ssh] or [hosts] badge so the source is visible
  • On alias collision ~/.ssh/config wins (its User / Port matter to ssh(1) at connect time)
  • Parallel installs capped at 5 concurrent, live ✓/✗ per host, exit summary

Flags:

FlagPurpose
--ssh-config <path>Override the ssh_config path (default: ~/.ssh/config)
--hosts-file <path>Override the hosts-file path (default: /etc/hosts)
--user <name>Default SSH user for /etc/hosts entries (ssh_config entries keep their own User)
--no-ssh-configSkip ~/.ssh/config
--no-hosts-fileSkip /etc/hosts
--yesSkip the picker, install on every non-skipped host

~/.hostatlas/cli.json, mode 0600, directory 0700:

{
"api_url": "https://my.hostatlas.app",
"api_key": "ha_xxxxxxxxxxxxxxxxxxxx"
}
Terminal window
# Bash
hostatlas completion bash > /etc/bash_completion.d/hostatlas
# Zsh
hostatlas completion zsh > "${fpath[1]}/_hostatlas"
# Fish
hostatlas completion fish > ~/.config/fish/completions/hostatlas.fish
# PowerShell
hostatlas completion powershell > hostatlas.ps1
  • All API communication enforces TLS 1.3 minimum
  • API keys authenticated via SHA-256 hash comparison server-side
  • Config file: 0600; config directory: 0700
  • No secrets logged or printed to stdout
  • MCP Server — same capabilities exposed to AI coding agents
  • Server CLI — the CLI’s on-server counterpart for executing recipes
  • SSH Client — desktop app the hostatlas ssh deep link opens
Was this page helpful?