SDK

Build on top of ZYRAXON from Node, with a typed client.

The ZYRAXON SDK lets you drive the engine from your own Node or TypeScript application. It works with Node 18+, Bun and Deno, and the public packages are published under the @zyraxon-ai npm scope.

Install

bash

npm install @zyraxon-ai/sdk
# or, for custom tools:
npm install @zyraxon-ai/plugin

Quick start

import { createZyraxonClient } from "@zyraxon-ai/sdk"

const client = createZyraxonClient({
  baseUrl: "http://localhost:3000",
})

const reply = await client.chat({
  message: "Explain this repository",
})

console.log(reply)

Streaming a session

import { createZYRAXON } from "@zyraxon-ai/sdk"

const zyraxon = await createZYRAXON({ directory: process.cwd() })
const session = await zyraxon.session.create()

for await (const event of zyraxon.session.prompt({
  sessionID: session.id,
  parts: [{ type: "text", text: "Explain this repository" }],
})) {
  console.log(event.type)
}

Package tiers

Tier	Packages	For
Public SDK	`@zyraxon-ai/sdk`, `@zyraxon-ai/plugin`	Everyone building on ZYRAXON
API building blocks	`@zyraxon-ai/schema`, `protocol`, `client`, `server`, `sdk-next`	Developers building agents
Internal	`@zyraxon-ai/core`, `llm`, `http-recorder`, `effect-drizzle-sqlite`, `effect-sqlite-node`	Used by the desktop app

Surfaces

Surface	What it is
Desktop	An Electron application for Windows, macOS and Linux
TUI	A terminal client
Server	An HTTP server you can point other tools at
SDK	A typed client for Node

ℹ