Where to read next, and what's actually real today.
Last verified 2026-08-02
fleetctl is a plugin-based fleet manager for home devices. This directory is the reader-facing documentation set; docs/architecture.md is the design source of truth and everything else here links into it rather than repeating it.
| Doc | For | What it covers |
|---|---|---|
getting-started.md |
A new contributor cloning the repo today | Install, first-run config, scan a subnet, plan and run a workflow |
cli-reference.md |
Anyone running a command | Every subcommand and flag, generated from the CLI's own --help |
configuration.md |
Anyone writing fleet.yml, .env, or devices.yml |
Every field in all three, with defaults and what each one gates |
architecture.md |
Anyone who wants the full design rationale | 15 sections, 21 diagrams: friction points in the predecessor, the three-ring design, config-as-code, workflows, observability, policy, MCP, and every locked decision (§15) |
pack-authoring.md |
Anyone writing a device pack or app pack | The extension contract: probes, capability declarations, effect classes, composition over inheritance |
safety.md |
Anyone who will point this at real hardware | Effect classes, protected devices, per-actor policy, plan-then-run, --approve, blast-radius caps — cross-referenced against ../SECURITY.md |
observability.md |
Anyone debugging a run or auditing what happened | The three separate streams (diagnostics, timeline, audit), why they're separate, and how correlation ids tie them together |
ha-parity.md |
Anyone working on the Home Assistant integration | All 21 panel commands mapped to their fleetctl equivalent, plus the behavioural differences the integration has to account for |
- New to the repo and want to run something →
getting-started.md - Looking up a specific command or flag →
cli-reference.md - Writing or editing
fleet.yml,.env, ordevices.yml→configuration.md - Want the full design before writing any code →
architecture.md - Planning to add a device type or an app →
pack-authoring.md - Concerned about what this tool can do to real hardware →
safety.mdand../SECURITY.md - Working on the Home Assistant integration →
ha-parity.md
|
fleetctl Documentation Index |
|
|
fleetctl