Getting started

Three short steps from zero to a working generator.

1. Install — pin the SDK in a PEP 723 inline-metadata script or in your pyproject.toml.
2. First generator — a 25-line shellcheck mirror.
3. Running locally — feed the JSON output to the ocx-mirror binary for a dry run.

Already comfortable? Jump to the Guide for REST-vs-GraphQL decisions, caching, and error handling.