Headless Daemon API Contract
Homeboy is CLI-first, but the daemon is the stable local UI and automation surface for clients that should not shell out and parse terminal output. The daemon remains a local Homeboy engine, not a hosted control plane.
Scope
The daemon owns a loopback-only HTTP contract for:
- local client discovery and health checks
- read-only component, rig, stack, run, artifact, and finding inspection
- long-running lint, test, audit, and bench jobs
- structured job events and final results
- future mutating operations behind explicit capabilities and confirmations
The CLI remains usable without the daemon. Daemon routes reuse Homeboy core and command adapters so desktop, web, agent, and CLI workflows do not fork product logic.
Discovery
Clients discover a local daemon through the CLI-managed state file instead of a hardcoded public port.
homeboy daemon start
|
+-- binds 127.0.0.1:<port>
+-- writes pid/address/token metadata to the daemon state file
|
homeboy daemon status --format=json
|
+-- returns the current loopback address and process stateRemote runner clients use homeboy runner connect <runner-id> to create an SSH
loopback tunnel to a runner daemon. The client still talks to a local loopback
URL; Homeboy owns the SSH tunnel and rejects non-loopback daemon addresses.
Minimum Dashboard Surface
A useful headless UI can be built from this read/query surface:
GET /healthandGET /versionfor connectivity and compatibilityGET /config/pathsfor local configuration discoveryGET /components,GET /components/:id,GET /components/:id/status, andGET /components/:id/changesfor source checkout selectionGET /rigs,GET /rigs/:id, andPOST /rigs/:id/checkfor environment readinessGET /stacks,GET /stacks/:id, andPOST /stacks/:id/statusfor stacked branch inspectionGET /runs,GET /runs/:id,GET /runs/:id/artifacts,GET /runs/:id/artifacts/:artifact_id/content, andGET /runs/:id/findingsfor persisted evidenceGET /audit/runsandGET /bench/runsfor analysis-specific run historyGET /jobs,GET /jobs/:id,GET /jobs/:id/events, andPOST /jobs/:id/cancelfor long-running work
This is enough for a dashboard that lists components, shows selected checkout state, displays rigs/stacks, starts analysis jobs, streams progress, and renders structured final results.
Job/Event Contract
Long-running analysis routes return immediately with a job record. Clients poll job state and events instead of holding a request open.
POST /lint|/test|/audit|/bench
|
v
{ "job": { "id": "...", "status": "queued" } }
|
+--> GET /jobs/:id
+--> GET /jobs/:id/events
+--> POST /jobs/:id/cancelEvents are append-only records. They are safe for UIs to render incrementally and safe for runners to mirror as evidence. The final result event carries the same structured result shape as the corresponding CLI command, including artifacts, findings, summaries, and CI context when a CI profile/job selector was used.
Client Replacement Order
Headless clients should replace shell-out flows in low-risk order:
- Discovery:
daemon status,health, andversion. - Dashboard reads: components, status, changes, rigs, stacks, runs, artifacts, and findings.
- Analysis jobs: lint, test, audit, and bench with event polling.
- Safe cancellation:
POST /jobs/:id/cancelfor daemon-owned queued/running jobs. - Mutating actions only after the capability and confirmation model below is implemented.
Mutating Endpoint Model
The daemon defaults to no write/operator capabilities. Future mutating endpoints must declare capability requirements before they are routed.
Suggested capability names:
read:componentsread:runsrun:lintrun:testrun:auditrun:benchwrite:fileswrite:gitwrite:rigwrite:stackoperator:sshoperator:deployoperator:release
Risk categories:
- Read-only: status, inventory, persisted runs, artifacts, findings.
- Bounded local run: lint, test, audit, bench, rig check, stack status.
- Local write: file edits, refactor fixes, generated patches.
- Git write: commit, tag, push, stack apply/sync/push.
- Environment write: rig up/down/service operations.
- Operator write: SSH execution, deploy, release, transfer, DB operations.
High-risk operations use a preview/apply contract:
POST /operations/preview
|
+-- validates capability
+-- returns operation_id, required_capabilities, risk, and plan/diff
POST /operations/:id/apply
|
+-- validates the same capabilities
+-- applies exactly the previewed plan
+-- runs as a job and emits events/resultsThe apply request must not accept a new free-form plan body. It applies the stored preview by id so clients cannot accidentally confirm one plan and execute another.
Default-Deny Rules
- Bind to loopback by default.
- Treat daemon tokens/capabilities as local secrets.
- Reject mutating routes until they declare required capabilities.
- Require preview/apply for high-risk writes.
- Run long writes as jobs with event trails and artifacts.
- Return enough structured data for review or undo where Homeboy has an undo primitive.