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/odo

# Login to your account
odo login

# List your instances and SSH in
odo list
odo 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/tap/odo

# Or install directly
brew install hostodo/tap/odo

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/odo-cli/releases/latest/download/odo_Darwin_arm64.tar.gz | tar xz
sudo mv odo /usr/local/bin/

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

Package Managers

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

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

From Source

Requires Go 1.25 or higher:

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

Authentication

The CLI uses OAuth device flow for secure authentication. When you run odo 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). On systems without a keychain, a plain token file is stored at ~/.odo/token with strict 0600 permissions.

Login

Copyodo login

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

Logout

Clear stored credentials:

Copyodo logout

Current User

Display information about the authenticated user:

Copyodo whoami

Active Sessions

View your active CLI sessions:

Copyodo auth sessions

Listing Instances

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

Copy# Interactive TUI (default)
odo list

# JSON output for scripting
odo list --json

# Simple ASCII table
odo list --simple

# Detailed view with all info
odo 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:

Copyodo status my-server
odo 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:

Copyodo start my-server

Stop

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

Copy# Graceful shutdown
odo stop my-server

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

Restart

Restart an instance. Waits up to 90 seconds:

Copy# Graceful restart
odo restart my-server

# Force restart
odo restart my-server --force

SSH Access

Connect to an instance via SSH using the system ssh binary. The SSH user is auto-detected from the OS template. If key-based auth fails and the instance has a default password, the CLI automatically retries using sshpass.

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

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

# Pass extra flags to the ssh binary (after --)
odo ssh my-server -- -L 8080:localhost:8080
odo ssh my-server -- -A -v

Rename

Rename an instance by updating its hostname:

Copyodo rename my-server new-name

Reinstall

Wipe and reinstall the OS on an existing instance. Optionally specify a different OS template and SSH key. This is destructive — all data on the instance will be lost.

Copy# Interactive — prompts for OS and SSH key
odo reinstall my-server

# Specify OS template
odo reinstall my-server --os "Debian 12"

# Specify OS and SSH key
odo reinstall my-server --os "Ubuntu 22.04" --ssh-key mykey

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 odo deploy without flags for a guided experience. The wizard walks you through selecting an OS template, region, plan, hostname, and optional SSH key.

Copyodo deploy

Non-interactive Mode

Skip prompts by passing flags:

Copy# Deploy with specific options
odo deploy --os "Ubuntu 22.04" --region DET01 --plan EPYC-2G1C32GN

# Custom hostname
odo deploy --hostname my-server

# Apply a promo code
odo deploy --promo LETCLI

# Skip confirmation
odo deploy --os "Ubuntu 22.04" --region DET01 --plan EPYC-2G1C32GN --yes

# Fully scripted deploy with promo
odo deploy --os "Ubuntu 22.04" --region DET01 --plan EPYC-2G1C32GN --billing-cycle monthly --promo LETCLI --yes

# JSON output (requires --os, --region, --plan)
odo deploy --os "Ubuntu 22.04" --region DET01 --plan EPYC-2G1C32GN --json

Invoices

List your invoices with optional filtering. Alias: bills.

Copy# List all invoices
odo invoices

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

Pay Invoice

Pay an invoice by its ID using your default payment method:

Copyodo pay INV-12345

# Skip confirmation prompt
odo pay INV-12345 --yes

SSH Key Management

List Keys

Copyodo keys list

Add a Key

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

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

Remove a Key

Aliases: rm, delete.

Copyodo 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
odo 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 ~/.odo/config.json:

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

Access tokens are stored separately in the OS keychain. On systems without a keychain, a plain token file is stored at ~/.odo/token with 0600 permissions.

Environment Variables

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

Shell Completion

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

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

# Zsh
odo completion zsh > "${fpath[1]}/_odo"

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

Global Flags

All commands support these flags: