Skip to content

Reference

Detailed specifications for the CLI, configuration schema, port scheme, and auto-generated API documentation.

In this section

  • CLI Reference — every verb and flag, derived from src/beetroot/cli.py.
  • Configuration — the beetroot.yaml schema: every field, its type, and its default.
  • Port Allocation — the stride-10 port scheme with the full table and the allocation algorithm.
  • API Reference — auto-generated documentation for the beetroot.* Python modules. Start at beetroot.api (Instance, Manager, DeviceBackend) for the high-level OOP surface re-exported from the top-level package; the procedural modules underneath stay public for contributors.