Homeboy documentation is organized by reader intent. If you are new, start with Start here. If you already know what you need, jump to workflows, concepts, reference, internals, or operations.

These docs are also embedded in the homeboy binary:

homeboy self docs list
homeboy self docs <topic>

Start Here

• Start here – first local run, smallest useful config, JSON evidence, and next steps.
• README – project overview and installation.

Workflows

Task-oriented guides for using Homeboy:

• Workflows index
• Review a branch
• Reproduce CI
• Capture evidence
• Use runners
• Set up Lab runners
• Set up extensions
• Run agent task loops
• Manage local environments
• Hold a PR fleet
• Release a component
• Deploy and operate fleets

Concepts

Mental models and vocabulary:

• Concepts index
• Homeboy model
• Structured evidence
• Headless agent orchestration
• Code Factory

Reference

Exact CLI, configuration, schema, and output details:

• Reference index
• Root command and global flags
• Command index
• Configuration reference
• Configuration precedence map
• Template variables
• Configuration schemas
• JSON output contract
• CI result JSON contract

Internals

Maintainer architecture and implementation contracts:

• Internals index
• Architecture overview
• Architecture cleanup map
• Agent runtime contract handshake
• Docs maintenance
• Embedded docs topic resolution

Operations

Runbooks for operators and agents:

• Operations index
• Release-gate proof path
• Controller to runner reverse-runner setup
• Artifact loop for runner and matrix workflows

Historical Reference

• Changelog
• Cross-compilation