This directory contains the markdown docs embedded into the homeboy binary and displayed via homeboy docs.

Homeboy is a config-driven automation engine for development and deployment automation, with standardized patterns and a stable JSON output envelope for most commands.

CLI

• Root command + global flags: Root command
• Full built-in command list: Commands index
• Code audit (convention drift, structural analysis): audit
• Config health checks: cleanup
• Changes summary: changes
• JSON output envelope: JSON output contract
• Embedded docs behavior: Embedded docs topic resolution
• Changelog content: Changelog
• Template variables: Template variables reference

Schemas

JSON configuration schemas for components, projects, servers, fleets, and extensions:

• Component schema – Buildable/deployable units
• Project schema – Deployable environments
• Server schema – SSH connection settings
• Fleet schema – Named groups of projects
• Extension manifest schema – Extension configuration

Architecture

Internal system architecture and internals:

• Architecture overview – High-level system design
• API client system – HTTP client and authentication
• Keychain/secrets management – Secure credential storage
• SSH key management – SSH key handling
• Release pipeline system – Local release orchestration
• Execution context – Runtime context for extensions
• Embedded docs – Documentation system internals

Developer Guide

Guides for contributing to Homeboy:

• Architecture overview – System architecture
• Config directory structure – File organization
• Error handling patterns – Error recovery strategies

Documentation Management

Homeboy provides tooling for AI-assisted documentation generation and maintenance:

• homeboy docs audit <component> – Validate documentation links, detect stale references and gaps
• homeboy docs map <component> – Generate machine-optimized codebase map for AI context
• homeboy docs generate --json – Bulk create documentation files from JSON spec
• homeboy docs documentation/index – Documentation philosophy and principles
• homeboy docs documentation/alignment – Instructions for maintaining existing docs
• homeboy docs documentation/generation – Instructions for generating new docs
• homeboy docs documentation/structure – File organization standards

Configuration

Configuration and state live under universal directory ~/.config/homeboy/ (all platforms).

• macOS: ~/.config/homeboy/
• Linux: ~/.config/homeboy/
• Windows: %APPDATA%homeboy

Common paths:

• ~/.config/homeboy/projects/
• ~/.config/homeboy/servers/
• ~/.config/homeboy/components/
• ~/.config/homeboy/fleets/
• ~/.config/homeboy/extensions/
• ~/.config/homeboy/keys/
• ~/.config/homeboy/backups/

Notes:

• Embedded CLI docs ship inside the binary (see Embedded docs topic resolution).

• Extension docs load from each installed extension’s docs/ folder under the Homeboy config root: ~/.config/homeboy/extensions/<extension_id>/docs/ (same topic-key rules as core docs).

• The CLI does not write documentation into ~/.config/homeboy/docs/.

• Cross-Compilation Guide – Platform requirements for native binaries