Quick start

Installation

Install via Homebrew:

brew install delaudio/tap/hum

Or build from source with a Rust toolchain:

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

Register a project

Register your project path using the CLI:

hum project register my-product ./hum.yaml

This creates or updates ~/.config/hum/config.yaml:

version: 1

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

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

version: 3
project: my-product

runtimes:
  local:
    type: process

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

services:
  web:
    runtime: local
    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