Quickstart

Get PulseDeck running and streaming live data in a few minutes. All you need is Docker.

1. Start PulseDeck

git clone https://github.com/me-shaon/pulsedeck.git pulsedeck
cd pulsedeck
docker compose up

Open http://localhost:3000, create your account and workspace, and you’re running.

2. Add a source

A source is any agent allowed to publish reports. In the app, go to Sources → Add source. PulseDeck gives you a one-time registration token (reg_…) and a ready-to-paste setup prompt.

pulsedeck.app / sources / new

SCREENSHOT

The Add source screen showing a registration token and setup prompt.

Drop an image into public/shots/ and pass src.

3. See it with live data

PulseDeck ships a demo agent that registers itself and sends realistic reports every 30 seconds — perfect for watching the UI come alive. Copy the reg_… token from the previous step and run:

pnpm --filter @pulsedeck/demo dev --url http://localhost:3000 --token reg_xxxxx

Charts, streams, and the live feed start populating right away.

The overview dashboard populated with reports from the demo agent.

What just happened

The demo agent did exactly what your own agents will do: it called POST /api/v1/sources/register with the token to get an API key, then POSTed reports to /api/v1/reports. No SDK, just HTTP.

Next steps

Connect your own agent — the report format and API.
Build a dashboard — assemble the view your team needs.
Self-hosting — run it for real, without Docker or in production.