Everything to build
on CAVS Hub.
Per-SDK guides, the one canonical API contract every client implements, authentication with service accounts, the architecture, and what's coming next. The full docs live in the repository's docs/ folder.
Start here.
Each SDK guide follows the same structure: requirements, install, auth, first upload & download, versioning, metadata, secrets, a CI example, retries, limits, common errors, compatibility, uninstall, migration, a full example and the metrics you'll see in CAVS.
Python SDK
Install, authenticate and run your first upload/download from Python. Typed exceptions, streaming transfers, runs & lineage.
Open the Python page → // @cavsnode/cavs-sdkTypeScript SDK
Node 18+ streaming client with ESM + CJS builds, an injectable fetch, and the same resource surface as Python.
Open the TypeScript page → // upload-artifactGitHub Action
Upload from a workflow with dedup-ratio outputs and CI attribution. OIDC support is on the roadmap.
Open the Action page →Deep docs in the repo.
| Document | What it covers |
|---|---|
CONTRACT.md | The canonical API: auth, endpoints, upload/download choreography, idempotency, telemetry, errors, cavs://. |
docs/ARCHITECTURE.md | How the SDKs relate to the Hub and the CLI; the content-addressed data plane. |
docs/authentication.md | Service accounts, cavs_sk_ keys, scopes, token resolution and security do's & don'ts. |
docs/python.md | The full Python guide (17-point structure). |
docs/typescript.md | The full TypeScript guide (17-point structure). |
docs/github-action.md | The full GitHub Action guide. |
docs/ROADMAP.md | Upcoming SDKs and integrations. |
What's next.
Two SDKs and a GitHub Action ship today. These build on the same canonical contract.
MLflow planned
mlflow-cavs — a custom artifact repository so mlflow.log_artifact writes to CAVS, mapping the MLflow run to a CAVS run.
Orchestrators planned
Kubeflow components (cavs-kfp) and an Airflow provider (apache-airflow-providers-cavs).
More SDKs planned
Go (cavs-go) and .NET (CAVS.SDK) — the latter powering the Unity and Unreal integrations.