Reference
The complete technical specification of Humanize as built: every command, option, grammar, key, screen, setting, protocol message, file, environment variable, Python symbol, default, limit and error. Each page states behaviour; tasks and explanations are in the User Guide, Writing Flows and Features.
Pages
| Page | Covers | Package |
|---|---|---|
| CLI | hmz, hmz exec, hmz internal …: synopsis, options, the -f/-a/-e/-p grammars, refusals, output and NDJSON schema, signals, exit statuses | hmz.cli |
| TUI | The interface hmz opens: views, status line, commands, keys, menus, /settings, the monitor, completion, history | hmz.tui |
| Web | The interface hmz web serves: letting a browser in, what is refused, the page's addresses, every route it calls, the stream | hmz.web |
| Daemon | The machine's daemon and its per-workspace host processes, their files, lifecycle, frame protocol, requests, messages and multi-frontend rules | hmz.daemon |
| SDK | hmz.sdk: every exported class, method, parameter, return type and exception | hmz.sdk |
| Flows | The flow API: @flow, roles, params, budgets, context, errors, testing | hmz.flows |
| Agents | Coding-agent drivers below the flow API: backends, sessions, hooks, fences | hmz.coganchor |
| Machines | Environments: local, ssh, docker, swarm, Apple containers, Slurm; runtimes | hmz.coganchor |
| Providers | Accounts an agent runs as, ways in | hmz.coganchor |
| Remote execution | hmz internal anchor: harness placement, targets, mirrors | hmz.coganchor |
| Tracing | Epics, journals, traces, profiling, export | hmz.runtime |
| Files | Everything under $HUMANIZE_HOME and a workspace's .hmz/ | — |
| Environment variables | Every variable any part of Humanize reads or sets | — |
| Settings | Every key of settings.yaml and the other stores the interface writes | — |
Lookup
| Looking for | Section |
|---|---|
an hmz exec option | CLI › Options |
the grammar of -a, -e, -p | CLI › Grammar |
why hmz exec refused a line | CLI › What is refused |
what hmz exec --json writes | CLI › --json |
| an exit status | CLI › Exit statuses |
a process named hmz internal … | CLI › hmz internal |
| a slash command, and when it is refused | TUI › Commands |
| a key | TUI › Keys |
| a menu, sheet or form | TUI › Menus, /settings |
| the monitor | TUI › Monitor |
| a route the web interface answers | Web › API |
| a daemon request or message | Daemon › Requests, Messages |
| a Python class or method | SDK |
a file under ~/.hmz | Files |
| an environment variable | Environment variables |
Conventions
| Notation | Meaning |
|---|---|
monospace | Literal text: typed, printed or stored exactly as shown. |
<name> | A placeholder for a value described alongside. |
[x] | Optional. |
x…, x [x …] | One or more. |
a | b | One of the alternatives. |
{a, b} | Every combination, as a shell brace expansion. |
| EBNF blocks | = defines, , concatenates, | alternates, [ ] optional, { } zero or more, ( ) groups, " " terminal, ? ? prose. |
~/.hmz | $HUMANIZE_HOME where set and non-empty. |
hmz: … | Text as printed; a leading hmz: or hmz exec: error: is part of the message. |
| Types | Python annotations as written in the source (str | None, tuple[str, ...]). |
| as local | A CLI running as this machine's own login, with no Humanize account. |
| workspace | The directory a run or an interface is started in (resolved path). |
| run | One execution of one flow; recorded as one epic. |
| role | A name a flow declares for an agent, an environment or an outworlder. |
| frontend | An interface or program attached to a host. |
Where behaviour and a spec under specs/ differ, these pages describe the behaviour of the code.