@bangstack/demo

Demo player for mesh-native apps with journey-driven interactive demos and CLI/PTY support.

Installation

npm install @bangstack/demo @bangstack/core

Quick Start

Browser Demo Player

import { createDemoPlayer } from '@bangstack/demo';
import { createMesh } from '@bangstack/core';
import { manifest } from './manifest.js';

const mesh = createMesh({ name: 'my-app' });

const player = createDemoPlayer(mesh, manifest, {
  cursor: true,      // Show animated cursor
  narration: true,   // Display narration text
  typing: true,      // Animate text input
});

// Play a journey as an interactive demo
await player.play('checkout-flow');

// Control playback
player.pause();
player.setSpeed(2);  // 2x speed
player.stop();

CLI Demo Server

import { createCliServer } from '@bangstack/demo/cli/server';

const server = createCliServer({
  port: 3200,
  cwd: process.cwd()
});

await server.start();
// Server streams PTY output to browser viewers

Features

• Journey playback: Play manifest journeys as interactive demos
• Animated cursor: Visual cursor follows actions
• Narration: Display contextual narration text
• CLI/PTY support: Stream terminal sessions to browsers
• Speed control: Adjust playback speed or use instant mode

License

MIT