Skip to content

SDK documentation#

Every SDK page on the BSR carries language-appropriate installation instructions for that SDK. For Go and TypeScript SDKs, the BSR additionally hosts a generated API reference pinned to the SDK’s plugin version and module commit.

Installation instructions#

Each SDK page (for example, the connectrpc/eliza SDK page on the BSR) shows a registry-specific install snippet for the language: go get for Go, the npm install command for TypeScript, the SPM or Xcode setup for Swift, and so on. If the language has no BSR-hosted package-manager registry, the page links to the archive download instead.

For SDKs without a hosted API reference, the install snippet plus the generated package itself (and any upstream-language documentation) is what users rely on.

API reference#

The BSR generates an API reference for Go and TypeScript SDKs and surfaces it from the SDK page.

Click the API reference button at the top right of the SDK section to open it.

BSR SDK section with the API reference button at the top right

The reference is pinned to the SDK’s plugin version and module commit, and is rendered in the form that’s standard for each language.

If a particular SDK’s reference hasn’t been generated yet, the BSR shows a “Docs Generating” banner while it produces one. After generation completes, the link points to the reference’s root. From there, opening a package shows its import statement and links to its descendants, so you can navigate the rest of the reference from those entries.