Reference

The pages below document the full surface of binoc's APIs and configuration formats. If you need a concrete walkthrough, see the tutorial. If you want to understand the design, see the architecture overview.

Start by role

• Anyone driving the CLI — start with CLI.
• Pipeline integrator — start with Changeset JSON schema and Dataset config.
• Python plugin author — start with Python API.
• Rust plugin author — start with Rust SDK and Plugin discovery.
• Plugin consumer reading changelog output — start with Plugin registry.
• Plugin consumer — start with Plugin catalog.

CLI and APIs

• binoc CLI — every subcommand and option, generated from the Rust source.
• Python API — the binoc Python package, generated from docstrings.
• Rust SDK — binoc-sdk crate, generated by cargo doc.

Data contracts

• Changeset JSON schema — the canonical contract for pipeline integrators.
• Dataset config — every key in a dataset YAML config and what it does.
• Plugin discovery — entry-point spec for Python and Rust plugins.
• Plugin registry — built-in and in-tree plugins readers will meet in rendered changelogs.
• Plugin catalog — format packs by file selector; generated from plugin_registry.json.