SDK Installation

Install and set up the @ziri/sdk package.

Install

npm install @ziri/sdk

Or with yarn:

yarn add @ziri/sdk

Or with pnpm:

pnpm add @ziri/sdk

Version Requirements

• Node.js 18.0.0 or higher
• Works in browsers (ES modules)
• Works in Node.js (CommonJS or ES modules)

TypeScript Support

The SDK includes TypeScript definitions. No additional @types package needed.

Import

ES Modules

import { UserSDK } from "@ziri/sdk";

CommonJS

const { UserSDK } = require("@ziri/sdk");

Environment Variables

Set ZIRI_PROXY_URL to avoid passing proxyUrl in the constructor:

export ZIRI_PROXY_URL=http://localhost:3100

Or in .env:

ZIRI_PROXY_URL=http://localhost:3100

Verify Installation

import { UserSDK } from "@ziri/sdk";

console.log("SDK loaded successfully");

Next Steps

• Usage Guide - Learn how to use the SDK
• API Reference - Complete method docs