<!-- x-generated: Generated by the Hyperscale artifact pipeline; do not edit by hand -->

# SDK packages

Generated SDK packages are proprietary Hyperscale artifacts. Public tenant TypeScript, Python, and Go SDK packages are generated from the contract surface. Downloaded Kits carry SDKs built from the same contract surface. Product-specific TypeScript packages are also served from the Product-authenticated hosted npm registry.

The install commands below prove local package layouts: paths starting `./sdks/` run from inside an unpacked Kit minted by the Product's Developers desk, while paths starting `./generated/` run from this repository tree. For CI, authenticate `GET /v1/llms.txt` with a Product API key to discover the exact Product-specific TypeScript package and `/v1/registry/npm/<environment>/` registry path.

| Package | Output | Channel | Audience | Language | Install | Notes |
| --- | --- | --- | --- | --- | --- | --- |
| @hyperscale/tenant-sdk | generated/sdks/public/tenant | public | tenant_sdk | typescript | `npm install ./sdks/typescript` | Committed source-review surface; Kits mint the built local package at download time. |
| hyperscale-tenant-sdk | generated/sdks/public/tenant-python | public | tenant_sdk | python | `pip install ./sdks/python` | Kit local-path package. |
| go.hyperscale.com/tenant-sdk | generated/sdks/public/tenant-go | public | tenant_sdk | go | `go mod edit -replace go.hyperscale.com/tenant-sdk=./sdks/go`<br>`go get go.hyperscale.com/tenant-sdk` | Kit local-path package. |
| @hyperscale/tenant-portal-sdk | generated/sdks/private/tenant-portal | private | tenant_portal | typescript | `npm install ./generated/sdks/private/tenant-portal` | Private Hyperscale release-lane package; built npm artifact with guarded dist exports; install from the built local path. |
| @hyperscale/admin-portal-sdk | generated/sdks/private/admin-portal | private | admin_portal | typescript | `npm install ./generated/sdks/private/admin-portal` | Private Hyperscale release-lane package; built npm artifact with guarded dist exports; install from the built local path. |

## Package documentation

Each committed package ships a README with install, first-call, retry, pagination, and webhook-verification guidance. Composition SDK packages carry their README inside the downloaded Kit:

- @hyperscale/tenant-sdk (typescript): [README](../sdks/public/tenant/README.md)
- hyperscale-tenant-sdk (python): [README](../sdks/public/tenant-python/README.md)
- go.hyperscale.com/tenant-sdk (go): [README](../sdks/public/tenant-go/README.md)
- @hyperscale/tenant-portal-sdk (typescript): [README](../sdks/private/tenant-portal/README.md)
- @hyperscale/admin-portal-sdk (typescript): [README](../sdks/private/admin-portal/README.md)

- Composition SDK packages: minted inside downloaded Kits from committed kit plans.
- Integration packs: generated/discovery/integration/ (JSON and llms-full per composition)