getting-started

Initialize Durable Streams with offset handling and live updates.

1.7k|64|Updated Dec 4, 2025
One-click install
npx skills add https://github.com/durable-streams/durable-streams --skill getting-started-durable-streams
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: getting-started
Source: https://github.com/durable-streams/durable-streams/tree/main/packages/client/skills/getting-started
Command: npx skills add https://github.com/durable-streams/durable-streams --skill getting-started-durable-streams

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Developers need a straightforward way to initialize Durable Streams, manage opaque offset tokens, and receive live updates without writing extensive boilerplate, enabling resilient real‑time data pipelines.

Core Features & Use Cases

  • Stream creation and writing with DurableStream.create() to append events.
  • Catch‑up and live reading using stream() with offset‑based reads and live tailing, supporting json() and subscribeJson() consumption methods.
  • Precise offset management allowing clients to resume from any point, essential for chat, collaboration, and event‑sourcing scenarios.

Quick Start

Ask the skill to create a Durable Stream, write a sample event, and start a live subscription.

Frequently Asked Questions about getting-started

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I set up real-time event streaming in TypeScript?

Real-time event streaming in TypeScript is set up by initializing Durable Streams with the @durable-streams/client library. You use DurableStream.create() to append events and stream() to read them with live tailing.

What is offset-based reading for event streams and when do I need it?

Offset-based reading allows clients to resume an event stream from any precise point using opaque tokens. You need this for resilient real-time data pipelines, chat applications, collaboration tools, and event-sourcing scenarios requiring catch-up capabilities.

How do I create and write to an event stream in a client-side application?

To create and write to an event stream in a client-side application, use the DurableStream.create() method. This appends events to the stream, enabling subsequent catch-up reads and live subscriptions via stream consumption methods.

Does the @durable-streams/client library support live mode for real-time updates?

Yes, the @durable-streams/client library supports LiveMode configurations for real-time updates. It allows clients to perform live tailing on streams using consumption methods like json() and subscribeJson() for continuous data delivery.

What is the best way to resume a real-time data stream after a disconnection?

The best way to resume a real-time data stream after disconnection is by using precise offset management. Durable Streams provide opaque offset tokens, allowing your client to catch up and continue reading from the exact event point where it left off.