@relayburn/sdk
v2.8.6
Published
Embeddable Relayburn SDK — napi-rs bindings over the Rust relayburn-sdk crate (2.x). Drop-in replacement for the TS @relayburn/[email protected].
Readme
@relayburn/sdk
Embeddable Relayburn SDK for Node.js. The package is a napi-rs facade over the
Rust relayburn-sdk crate.
The package resolves the native binding for your platform via
optionalDependencies:
| Platform | Package |
|---|---|
| darwin-arm64 (Apple Silicon) | @relayburn/sdk-darwin-arm64 |
| darwin-x64 (Intel Mac) | @relayburn/sdk-darwin-x64 |
| linux-arm64-gnu | @relayburn/sdk-linux-arm64-gnu |
| linux-x64-gnu | @relayburn/sdk-linux-x64-gnu |
Windows (win32-x64-msvc) is not yet shipped — see #247 follow-up.
API Notes
- Large u64 token counts may be
bigint. napi-rs maps Rustu64to JavaScriptBigInt; the facade downcasts safe-range integers tonumberand leaves larger values asbigint. The declarations widen these fields tonumber | bigint. - The SDK exposes read verbs such as
summary(),sessionCost(),hotspots(),compare(),search(),exportLedger(), andexportStamps(). - Launchers can call
writePendingStamp({ harness, cwd, enrichment })before spawning Claude, Codex, or OpenCode, then runingest()to fold those generic enrichment tags onto the discovered turns.
