haloyadm

Complete reference for haloyadm server administration commands.

Commands run on the server to manage the Haloy daemon and services.

Commands

init

Initialize haloyd and HAProxy (first-time setup).

# Basic initialization
sudo haloyadm init

# Initialize with API domain and TLS
sudo haloyadm init --api-domain haloy.example.com --acme-email you@example.com

# Initialize for non-root installation
haloyadm init --local-install

Options:

  • --api-domain <domain> - Domain for Haloy API with TLS
  • --acme-email <email> - Email for Let’s Encrypt certificates
  • --local-install - Install in user directory (non-root)

start

Start haloyd and HAProxy services.

# Start services
sudo haloyadm start

# Start with local development image
sudo haloyadm start --dev

# Start with debug logging
sudo haloyadm start --debug

# Combine options
sudo haloyadm start --dev --debug

Options:

  • --dev - Use local haloyd image for development
  • --debug - Enable debug mode with verbose logging

stop

Stop haloyd and HAProxy services.

sudo haloyadm stop

restart

Restart haloyd and HAProxy services.

sudo haloyadm restart

Options:

  • --dev - Use local haloyd image
  • --debug - Enable debug mode

api token

Generate a new API token.

sudo haloyadm api token

Returns a token that can be used with haloy server add on local machines.

api domain

Set or update the API domain and TLS configuration.

# Set API domain with TLS
sudo haloyadm api domain <domain> <email>

# Example
sudo haloyadm api domain haloy.example.com admin@example.com

Arguments:

  • <domain> - Domain for the Haloy API
  • <email> - Email address for Let’s Encrypt certificates

version

Display the CLI version.

haloyadm version

Outputs only the CLI version number in plaintext (e.g., 0.1.0).

Exit Codes

The haloyadm CLI uses consistent exit codes:

  • 0 - Success
  • 1 - Any error