Homeboy
Homeboy CLI documentation
This directory contains the markdown docs embedded into the homeboy binary and displayed via homeboy docs. Homeboy is headless automation...
Changelog
All notable changes to Homeboy CLI are documented in this file. (This file is embedded into the CLI binary and...
Configuration Reference
This page is a field-level reference for Homeboy configuration structures. For the higher-level system model and core/extension boundary, see Architecture...
Cross-Compilation Guide
Homeboy can orchestrate releases for any platform, but building native binaries requires access to that platform's toolchain. What Works Anywhere...
Code Factory
The code factory is homeboy's model for automated code maintenance: humans write features, the system maintains quality. It combines lint,...
Template Variables
Homeboy supports template variables in several contexts. Both single-brace ({var}) and double-brace ({{var}}) syntaxes are supported everywhere for backward compatibility....
Extension Manifest Schema
Extension manifests define extension metadata, runtime behavior, platform behaviors, and integration points. Stored as <extension_id>/<extension_id>.json in the extension directory. Schema...
Project Schema
Project configuration defines environment-specific context stored in projects/<id>.json: server bindings, domains, local paths, remote paths, project-scoped CLI settings, API settings,...
Fleet Schema
Fleet configuration defines named groups of projects stored in fleets/<id>.json. Schema { "id": "string", "project_ids": ["string"], "description": "string" } Fields...
Component Schema
Component configuration defines buildable and deployable units stored in components/<id>.json. Schema { "id": "string", "name": "string", "local_path": "string", "remote_path": "string",...
Server Schema
Server configuration defines SSH server connections stored in servers/<id>.json. Schema { "id": "string", "name": "string", "host": "string", "port": number, "user":...
Portable Component Config (`homeboy.json`)
A homeboy.json file in a repo root defines portable component configuration that travels with the code. Clone a repo, run...
Commands index
api agent-task audit — code convention drift and structural analysis auth bench — performance benchmarks + p95 regression ratchet build...
`homeboy rig`
Manage local dev rigs: reproducible multi-component environments that can start services, prepare checkouts, sync combined-fixes stacks, run health checks, and...
Bench Command
Run performance benchmarks for a Homeboy component and surface regression deltas against a stored baseline. Synopsis homeboy bench <component> [options]...
Runs Command
Inspect persisted observation-store runs and artifacts. Synopsis homeboy runs list [--runner <runner-id>] [--kind bench|rig|trace] [--component <id>] [--rig <id>] [--status <status>]...
`homeboy runner`
Synopsis homeboy runner <COMMAND> runner manages durable execution backends. SSH runners are a capability on a homeboy server record, so...
`homeboy daemon`
Run and inspect the local-only Homeboy HTTP API daemon. Synopsis homeboy daemon <COMMAND> Subcommands start — start the local daemon...
Runner contract
The contract between Homeboy core and runner scripts: what capabilities exist, what env vars flow in, what sidecar files scripts...
Agent task executor adapter
Agent task executor adapters are the boundary between Homeboy core and the systems that actually run agent work. Core owns...
Preview Metadata
Homeboy preserves generic preview metadata without owning public-access setup. Commands, extensions, wrappers, or external integrations can emit preview facts through...
Rig Matrix Axis Composition
Design for deriving rig variants from one base rig plus explicit axis overlays. Status: design proposal. homeboy rig matrix and...
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...
Planned Change Execution
Homeboy's planned-change vocabulary is the shared core language for work that starts as a plan and may eventually mutate files...
Controller to runner reverse-runner setup
This guide is the operator runbook for using any Homeboy-managed controller machine as a broker while any configured runner machine...
Architecture Overview
Homeboy is headless automation for agentic software engineering workflows. It is built in Rust with a config-driven, extension-oriented architecture that...
Config Directory Structure
Important: Portable component configuration can live in a repo-level homeboy.json. Reusable machine-local configuration, state, installed extensions, projects, servers, fleets, rigs,...
Error Handling Patterns
Homeboy uses a centralized error system for consistent error reporting across all commands. Error Categories Errors are categorized by type...
`homeboy` root command
Synopsis homeboy [OPTIONS] <COMMAND> Description homeboy is headless automation for agentic software engineering workflows. It keeps local developers, CI, scheduled...
Dead Guard Detection
Homeboy audit flags function_exists('…'), class_exists('…'), and defined('…') guards whose checked symbol is guaranteed to exist at runtime. Such guards are...
Repeated literal-shape detector
Detects inline associative array literals that appear many times with the same shape (ordered keys + value kinds) across a...
Shared scaffolding detector
Finds groups of classes in the same directory subtree that share the same overall method-shape (same method names, visibilities, and...
Audit Deprecation Age
Homeboy audit flags @deprecated X.Y.Z docblock tags that are significantly older than the component's current version. This surfaces ancient deprecations...
Compiler Warning Extension Contract Gap
Issue #2242 asks Homeboy core to move compiler-warning collection and compiler-warning fix generation behind extension-owned contracts. Validation and formatting already...
Verification phase contract
Homeboy's verification surface is deliberately split into isolated primitive commands that can be composed by higher-level workflows. Primitive phases The...
Documentation Alignment
Instructions for keeping existing .md documentation synchronized with current codebase implementation. Scope Alignment covers documentation that describes current implementation only....
Documentation Generation
Instructions for creating comprehensive user-facing documentation from scratch by analyzing the codebase. Purpose Generate structured documentation in the /docs directory...
Documentation Structure
Standard patterns for organizing documentation files and directories. Directory Conventions /docs Directory User-facing documentation lives in /docs at the project...
Documentation Management
Homeboy provides AI agents with consistent instructions for documentation generation and maintenance. These docs serve as the single source of...