Hostodo CLI

Deploy, manage, and SSH into your VPS instances from the command line. Available for macOS, Linux, and Windows.

# Install via Homebrew
brew install hostodo/tap/hostodo

# Login to your account
hostodo login

# List your instances and SSH in
hostodo list
hostodo ssh my-server

Installation

Homebrew (macOS & Linux)

The recommended way to install the Hostodo CLI:

Copy# Add the Hostodo tap and install
brew tap hostodo/tap
brew install hostodo

# Or install directly
brew install hostodo/tap/hostodo

Download Pre-built Binary

Download binaries from the releases page. Available for macOS (Intel & Apple Silicon), Linux (amd64, arm64), and Windows (amd64).

Copy# macOS (Apple Silicon)
curl -L https://github.com/hostodo/hostodo-cli/releases/latest/download/hostodo_Darwin_arm64.tar.gz | tar xz
sudo mv hostodo /usr/local/bin/

# Linux (amd64)
curl -L https://github.com/hostodo/hostodo-cli/releases/latest/download/hostodo_Linux_x86_64.tar.gz | tar xz
sudo mv hostodo /usr/local/bin/

Package Managers

Copy# Debian / Ubuntu
wget https://github.com/hostodo/hostodo-cli/releases/latest/download/hostodo_Linux_x86_64.deb
sudo dpkg -i hostodo_Linux_x86_64.deb

# RHEL / CentOS / Fedora
wget https://github.com/hostodo/hostodo-cli/releases/latest/download/hostodo_Linux_x86_64.rpm
sudo rpm -i hostodo_Linux_x86_64.rpm

From Source

Requires Go 1.24 or higher:

Copygit clone https://github.com/hostodo/hostodo-cli.git
cd hostodo-cli
make install

Authentication

The CLI uses OAuth device flow for secure authentication. When you run hostodo login, a browser window opens where you authorize the CLI with your Hostodo account. Your tokens are securely stored in the OS keychain (macOS Keychain, Linux Secret Service) with an encrypted file fallback.

Login

Copyhostodo login

This opens your default browser to authorize the CLI. Once approved, you're authenticated and ready to go.

Logout

Clear stored credentials:

Copyhostodo logout

Current User

Display information about the authenticated user:

Copyhostodo whoami

Active Sessions

View your active CLI sessions:

Copyhostodo auth sessions

Listing Instances

List all your VPS instances. Aliases: ls, ps.

Copy# Interactive TUI (default)
hostodo list

# JSON output for scripting
hostodo list --json

# Simple ASCII table
hostodo list --simple

# Detailed view with all info
hostodo list --details

The default interactive TUI supports keyboard navigation:

• ↑ / ↓ or j / k — Navigate through instances
• Enter — View detailed instance information
• q or Esc — Quit

Instance Status

Get detailed information about a specific instance:

Copyhostodo status my-server
hostodo status my-server --json

Displays basic info, network configuration, resource allocation (RAM, CPU, disk, bandwidth), plan details, billing information, and timestamps.

Example output:

Power Control

Start

Start a stopped instance. Waits up to 30 seconds for the instance to boot:

Copyhostodo start my-server

Stop

Stop a running instance. Waits up to 60 seconds for graceful shutdown:

Copy# Graceful shutdown
hostodo stop my-server

# Force immediate shutdown
hostodo stop my-server --force

Restart

Restart an instance. Waits up to 90 seconds:

Copy# Graceful restart
hostodo restart my-server

# Force restart
hostodo restart my-server --force

SSH Access

Connect to an instance via SSH. The CLI uses the system ssh binary and auto-detects the SSH user from the instance's OS template. If key-based auth fails and the instance has a default password, it automatically retries with sshpass.

Copy# SSH with auto-detected user
hostodo ssh my-server

# Specify a different user
hostodo ssh my-server --user ubuntu

Hostname Resolution

All instance commands accept hostnames as the primary identifier. The CLI resolves hostnames using a three-step fallback:

1. Exact match — Full hostname match (e.g., my-server)
2. Prefix match — Unambiguous prefix (e.g., my-s resolves to my-server if unique)
3. Instance ID fallback — Direct instance ID (e.g., ins::abc123)

Tab completion for hostnames is available when shell completions are enabled.

Deploy Instances

Deploy a new VPS instance with an interactive wizard or by passing flags. Aliases: new, create.

Interactive Mode

Run hostodo deploy without flags for a guided experience. The wizard walks you through selecting an OS template, region, plan, hostname, and optional SSH key.

Copyhostodo deploy

Non-interactive Mode

Skip prompts by passing flags:

Copy# Deploy with specific options
hostodo deploy --os "Ubuntu 22.04" --region "Los Angeles" --plan KVM-2G

# Custom hostname
hostodo deploy --hostname my-server

# Skip confirmation
hostodo deploy --os "Ubuntu 22.04" --region "Los Angeles" --plan KVM-2G --yes

# JSON output (requires --os, --region, --plan)
hostodo deploy --os "Ubuntu 22.04" --region "Los Angeles" --plan KVM-2G --json

Invoices

List your invoices with optional filtering. Alias: bills.

Copy# List all invoices
hostodo invoices

# Show only unpaid invoices
hostodo invoices --status=unpaid

Pay Invoice

Pay an invoice by its ID:

Copyhostodo pay INV-12345

SSH Key Management

List Keys

Copyhostodo keys list

Add a Key

Copy# Add key inline
hostodo keys add mykey "ssh-rsa AAAAB3NzaC1yc2EAAA... user@host"

# Add key from file
hostodo keys add mykey --file ~/.ssh/id_rsa.pub

Remove a Key

Copyhostodo keys remove mykey

Output Formats

Commands that display data support multiple output modes:

Interactive TUI (default)

A keyboard-navigable, color-coded table that adapts to your terminal size. Use arrow keys or j/k to navigate, Enter to view details.

JSON (--json)

Structured JSON output, perfect for scripting and piping to tools like jq:

Copy# Get running instances as JSON
hostodo list --json | jq '.[] | select(.status == "running")'

Simple Table (--simple)

Clean ASCII table for quick viewing or piping:

Detailed View (--details)

Comprehensive, human-readable output per instance:

Configuration

Config File

Configuration is stored at ~/.hostodo/config.json:

{
  "api_url": "https://api.hostodo.com",
  "device_id": "a1b2c3d4-..."
}

Access tokens are stored separately in the OS keychain, with an AES-encrypted file fallback at ~/.hostodo/token.enc when no keychain is available.

Environment Variables

Copy# Use a custom API endpoint
export HOSTODO_API_URL=https://custom-api.example.com
hostodo login

Shell Completion

Generate completion scripts for your shell. This enables tab-completion for commands and hostnames.

Copy# Bash
hostodo completion bash > /etc/bash_completion.d/hostodo

# Zsh
hostodo completion zsh > "${fpath[1]}/_hostodo"

# Fish
hostodo completion fish > ~/.config/fish/completions/hostodo.fish

Global Flags

All commands support these flags: