Skip to content
HEBBS

TypeScript SDK Installation

Requirements

Section titled “Requirements”
  • Node.js 18 or later — the SDK targets ES2022 and uses modern Node.js APIs.
  • A running HEBBS server to connect to (see Deployment).

Install with npm

Section titled “Install with npm”
Terminal window
npm install @hebbs/sdk

To pin to a specific version:

Terminal window
npm install @hebbs/[email protected]

Install with pnpm

Section titled “Install with pnpm”
Terminal window
pnpm add @hebbs/sdk

Install with yarn

Section titled “Install with yarn”
Terminal window
yarn add @hebbs/sdk

Verify Installation

Section titled “Verify Installation”
import { HebbsClient } from '@hebbs/sdk';
console.log('SDK loaded successfully');

Dependencies

Section titled “Dependencies”

The SDK has two runtime dependencies, both installed automatically:

PackagePurpose
@grpc/grpc-jsPure-JavaScript gRPC implementation (no native addons)
@grpc/proto-loaderRuntime protobuf parsing from the shipped .proto file

Supported Platforms

Section titled “Supported Platforms”

The SDK is a pure-JavaScript package (ESM) and supports all platforms where Node.js 18+ runs:

  • Linux (x86_64, aarch64)
  • macOS (x86_64, Apple Silicon)
  • Windows (x86_64)

Next Steps

Section titled “Next Steps”