Quick start

Install from source

Install a current Rust toolchain, then build and install hum:

git clone https://github.com/delaudio/hum.git
cd hum
cargo install --path .

Register a project

Create ~/.config/hum/config.yaml:

version: 1

projects:
  my-product:
    config: ~/code/my-product/hum.yaml

The referenced project configuration defines repositories, services, and templates. A minimal hum.yaml looks like this:

version: 2
project: my-product

repositories:
  app:
    path: ~/code/my-product

services:
  web:
    repository: app
    command: npm run dev
    port: 3000
    url: http://localhost:3000

templates:
  default:
    services: [web]

Validate and start

hum my-product default config validate
hum my-product default doctor
hum my-product default start
hum my-product default status

start launches the service in a detached process group, writes runtime state and logs, and exits. Open the monitor with:

hum my-product default tui

When finished, stop the template explicitly:

hum my-product default stop