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 - first local run, smallest useful config, JSON evidence, and next steps.
- README - project overview and installation.
Task-oriented guides for using Homeboy:
- Workflows index
- Review a branch
- Reproduce CI
- Capture evidence
- Use runners
- Set up Lab runners
- Set up extensions
- Manage local environments
- Hold a PR fleet
- Release a component
- Deploy projects
Mental models and vocabulary:
Exact CLI, configuration, schema, and output details:
- Reference index
- Root command and global flags
- Command concepts and workflows
- Runtime command index:
homeboy self docs commands/commands-index - Exact command help:
homeboy <command> --help - Configuration reference
- Configuration precedence map
- Template variables
- Configuration schemas
- JSON output contract
- CI result JSON contract
Maintainer architecture and implementation contracts:
- Internals index
- Architecture overview
- Architecture cleanup map
- Agent runtime contract handshake
- Docs maintenance
- Embedded docs topic resolution
Runbooks for operators and agents: