Fleet Schema
Fleet configuration defines named groups of projects stored in fleets/<id>.json.
Schema
json
{
"id": "string",
"project_ids": ["string"],
"description": "string"
}Fields
Required Fields
id(string): Unique fleet identifierproject_ids(array of strings): List of project IDs in this fleet
Optional Fields
description(string): Human-readable description of the fleet’s purpose
Example
json
{
"id": "production",
"project_ids": [
"extrachill",
"sarai-chinwag",
"chubes-net"
],
"description": "Production WordPress sites sharing common plugins"
}Use Cases
Multi-Site Deployment
Group sites that share components for coordinated deployments:
bash
homeboy deploy my-plugin --fleet productionEnvironment Grouping
Separate staging and production environments:
json
{
"id": "staging",
"project_ids": ["site-a-staging", "site-b-staging"],
"description": "Staging environments for testing"
}Component-Based Grouping
Group by shared technology:
json
{
"id": "wordpress-sites",
"project_ids": ["blog", "shop", "docs"],
"description": "All WordPress-based sites"
}Storage Location
Fleets are stored as individual JSON files under the OS config directory:
- macOS/Linux:
~/.config/homeboy/fleets/<id>.json - Windows:
%APPDATA%homeboyfleets<id>.json
Fleet Operations
Create a Fleet
bash
homeboy fleet create production --projects site-a,site-b,site-cAdd/Remove Projects
bash
homeboy fleet add production --project new-site
homeboy fleet remove production --project old-siteCheck Fleet Status
bash
# Local version info
homeboy fleet status production
# Drift detection (compares local vs remote via SSH)
homeboy fleet check production
homeboy fleet check production --outdatedDeploy to Fleet
bash
# Deploy specific component to fleet
homeboy deploy my-plugin --fleet production
# Deploy to all projects using a component
homeboy deploy my-plugin --sharedShared Component Detection
Before creating fleets, see which components are shared:
bash
homeboy component shared
# → my-plugin: [site-a, site-b, site-c]
# → homeboy: [project-1, project-2]This helps identify natural groupings for fleet creation.
Related
- Fleet command – Fleet management commands
- Deploy command –
--fleetand--sharedflags - Component command –
component sharedcommand - Project schema – Project configuration