@osaurus/sdk

Osaurus SDK for Node.js and Electron.

Installation

npm install @osaurus/sdk
# or
pnpm add @osaurus/sdk
# or
yarn add @osaurus/sdk
# or
bun add @osaurus/sdk

Usage

import { discover } from "@osaurus/sdk";

const instance = await discover();
console.log("Osaurus running at:", instance.url);

Examples

See examples folder for complete examples:

• Basic - Basic usage of the SDK.
• With OpenAI - Using the SDK with OpenAI.
• Streaming - Using the SDK with streaming.
• Electron - Using the SDK with Electron.

Run examples locally

cd examples
bun install
bun run basic

API

• discover(): Promise<OsaurusInstance>

Discovers the latest running Osaurus instance.

Returns:

• instanceId: Unique instance identifier
• url: Base URL for API calls
• port: Port number
• address: IP address
• exposeToNetwork: Whether exposed to LAN
• updatedAt: Last update timestamp

Throws if no running instance found.

License

MIT