Skip to main content

Milou CLI: Command Reference

This document provides a comprehensive reference for the milou command-line tool.

Core Commands​

milou setup​

Initializes the Milou environment. This command runs an interactive wizard that helps you configure the domain, administrator email, SSL settings, and GHCR authentication. It generates the .env file with secure secrets.

# Run interactive setup
milou setup

# Run non-interactive setup (requires environment variables)
milou setup --yes

milou start​

Starts all Milou services using the configured Docker Compose stack. It ensures the necessary images are present and the containers are launched in the correct order.

milou stop​

Stops all running Milou services.

milou restart​

Restarts all Milou services. Useful for applying configuration changes.

milou status​

Displays the current status of all Milou containers, similar to docker compose ps, but with additional health reporting.

Configuration & Secrets​

milou config​

Safely manages the .env configuration file.

  • milou config get <KEY>: Retrieve a value.
  • milou config set <KEY> <VALUE>: Set a value (atomic write).
  • milou config show: Display the current configuration.
  • milou config validate: Check configuration integrity.

milou ssl​

Manages SSL certificates.

  • milou ssl setup: Interactive wizard for SSL configuration.
  • milou ssl generate: Generate self-signed certificates.
  • milou ssl import <key> <cert>: Import existing certificates.
  • milou ssl info: Display certificate details.
  • milou ssl renew: Renew certificates (if using Let's Encrypt/Certbot - integration dependent).

milou ghcr​

Manages GitHub Container Registry authentication.

  • milou ghcr setup: Interactive prompt to enter your PAT.
  • milou ghcr login: Authenticate with Docker using the stored token.
  • milou ghcr status: Check authentication status.

Maintenance & Updates​

milou update​

Updates the Milou platform to the latest version (or a pinned version).

  1. Pulls the latest images.
  2. Runs database migrations.
  3. Restarts services.
# Update to latest available version in current channel
milou update

# Update to a specific version
milou config set MILOU_VERSION 1.2.0
milou update

milou backup​

Creates a backup archive containing the configuration (.env), SSL certificates, and other critical state files.

milou backup [name]

milou restore​

Restores the system configuration from a backup archive.

milou restore <backup_file_path>

milou logs​

Views logs from the running services.

# View logs for all services
milou logs

# View logs for a specific service (e.g., backend)
milou logs backend

Advanced Commands​

milou db​

Database management utilities.

  • milou db migrate: Manually run database migrations.

milou version​

  • milou version show: Display current CLI and image versions.
  • milou version check: Check for available updates.