Install the TypeScript SDK

The Beacon software development kit (SDK) provides TypeScript methods for supported developer operations.

Prerequisites

• Use Bun in your project.
• Create a Beacon workspace.
• Create an agent key before the first request.

Install

bun add @beacon/sdk

Import the client

import { BeaconClient, BeaconError } from "@beacon/sdk";

The SDK does not install other packages. You can use it with Bun, browsers, and Node.js.

Next step

Create an agent key, then authenticate a client.