Retriever Hub
Retriever Hub loads reusable robot code straight from a git repository. Point it at org/name:Export and it returns the object — a Flow class, a type, a transform, or a pipeline builder — with no PyPI wheel and no copied source.
A module declares its public surface in one [tool.retriever.module] manifest section. hub.use reads that manifest from the repo, imports the declared package under a private commit-scoped namespace, and hands back the requested export.
Three surfaces, one distribution path
Section titled “Three surfaces, one distribution path”- Core runtime —
retriever-core, imported asretriever. Flow, Clock, sync policies, Pipeline, stepping, replay, IR, backends, and the standard types inretriever.types.*. - Retriever Hub — the manifest + index protocol that turns any repo into a loadable pack of Flows, types, transforms, and composed pipelines.
- GoldenRetriever — the maintained applied catalog: a real Hub type pack of robot-facing payloads, plus example lanes. Built on the runtime, not a second one.
Reach for Hub when a robot system should reuse a stable boundary instead of copying code.
One runnable proof
Section titled “One runnable proof”The primitive Hub distributes is a composable pipeline. Prove it composes locally — this runs in the core checkout:
A registered pipeline can be extended in place or dropped in as a single Flow stage — the two surfaces a Hub module exports. For the loader running against a real manifest, see the GoldenRetriever pack proof.
hub.use(…) resolves a ref: index, git tag, cache, and the return contract.PublishingMake your repo hub-loadable: the real [tool.retriever.module] manifest and import-safety rules.Composable pipelinesExport a pipeline builder, then reuse it as a live graph or one Flow stage.GoldenRetriever packsGoldenRetriever as a Hub type pack, with a runnable manifest-load proof.First GoldenRetriever proofThe applied Hub-pack path, then perception, memory, simulation, and visualization lanes.Recommended route
Section titled “Recommended route”- Run the core visual quickstart.
- Read Hub packs and modules for refs, exports, and loading semantics.
- Run the GoldenRetriever pack proof to watch a real manifest load through the Hub loader.
- Read Publishing when you want to expose your own repo the same way.
The boundary to keep straight: GoldenRetriever is not a second runtime package. The runtime is retriever-core (imports as retriever); GoldenRetriever is the maintained examples and pack surface on top of it.
