FluxyChat Docs

You need a Worker URL. Public rooms: FluxyRealtimeProvider + publishableKey, or joinPublicRoomAsGuest / FluxyChatWidget guest. Production: mint a member JWT after sign-in.

Quickstart

pk_ first, then CLI, then member JWT.

Choose a path

Hosted CLI, self-host, or SDK-only.

What to build

Map a product idea to primitives.

Gallery

All --example apps. Scope of each template.

Wire protocol

What the socket actually does.

CLI and examples

Flags, env vars, JWT mint.

Client setup

React, vanilla, React Native, Flutter.

Self-hosting

Your Cloudflare account.

Self-host cost

What Cloudflare bills. Not our invoice.

Hosted

npx @fluxy-chat/create-fluxy-chat@latest my-app --mode hosted -y
cd my-app && pnpm install && pnpm setup:hosted && pnpm dev

Console: fluxychat.com/dashboard. Then open two tabs.

Concepts: which primitive to use
Connection state: including degraded-http
API reference: REST

Getting started