Skip to main content

BB-Eco API & Reference

Stable, machine-readable interfaces for BB-Eco, versioned independently of the rest of the documentation.

What lives here​

  • BB-Eco CLI: every bb-eco command, subcommand, argument, and option, auto-generated from the live CLI help. Run from scripts, CI pipelines, scheduled audits, or any context that doesn't want a desktop session.
  • Template JSON format: the schema for bb-eco template export / apply / diff. Section-by-section field reference, "null means don't touch" semantics, apply order, and downloadable reference templates for the ED and ES ranges.

Coming later​

  • .NET Core library (Brainboxes.Eco.Core): for embedding BB-Eco's discovery and upgrade primitives into your own .NET applications.
  • Sidecar JSON-RPC + WebSocket protocol: the wire protocol the BB-Eco desktop app speaks to its sidecar, available to any client that wants the same capabilities from another language.

Both ship after the BB-Eco 1.0 release once their public surface stabilises.

Versioning​

This reference tracks the latest BB-Eco release. The CLI pages are regenerated from the live CLI help text on every release, so what you read here matches the newest build; older builds may lack the newest commands and options. Check with bb-eco --help on your machine.

See also​