Quick Start

Get Nexo running in under 30 seconds with Docker and the TypeScript SDK.

1. Run the Server

The Docker image is available on Docker Hub.

docker run -d -p 7654:7654 emanuelepifani/nexo

This exposes:

• Port 7654 (TCP): Client TCP socket for SDK connections.

2. Install the SDK

SDK package on npm.

npm install @emanuelepifani/nexo-client

3. Connect & Use

typescript

import { NexoClient } from '@emanuelepifani/nexo-client';

// Connect once
const client = await NexoClient.connect({ host: 'localhost', port: 7654 });

// --- Store (Shared state) ---
await client.store.map.set("user:1", { name: "Max", role: "admin" });
const user = await client.store.map.get("user:1");

// --- Pub/Sub (Realtime events) ---
await client.pubsub('alerts').subscribe(async (msg) => console.log(msg));
await client.pubsub('alerts').publish({ level: "high" });

// --- Queue (Background jobs) ---
const mailQ = await client.queue("emails").create();
await mailQ.push({ to: "test@test.com" });
await mailQ.subscribe(async (msg) => console.log(msg));

// --- Stream (Event log) ---
const stream = await client.stream('user-events').create();
await stream.publish({ type: 'login', userId: 'u1' });
await stream.subscribe('analytics', async (msg) => console.log(msg));

python

from nexo import NexoClient, NexoQueue, NexoStream, NexoTopic

# Connect once
client = await NexoClient.connect(host="localhost", port=7654)

# --- Store (Shared state) ---
await client.store.map.set("user:1", {"name": "Max", "role": "admin"})
user: User | None = await client.store.map.get("user:1")

# --- Pub/Sub (Realtime events) ---
async def on_alert(msg: Alert) -> None:
    print(msg)

alerts: NexoTopic[Alert] = client.pubsub("alerts")
await alerts.subscribe(on_alert)
await alerts.publish({"level": "high"})

# --- Queue (Background jobs) ---
async def handle_email(msg: Email) -> None:
    print(msg)

mail_q: NexoQueue[Email] = await client.queue("emails").create()
await mail_q.push({"to": "test@test.com"})
await mail_q.subscribe(handle_email)

# --- Stream (Event log) ---
async def on_event(msg: UserEvent) -> None:
    print(msg)

stream: NexoStream[UserEvent] = await client.stream("user-events").create()
await stream.publish({"type": "login", "userId": "u1"})
await stream.subscribe("analytics", on_event)