Documentation

The protocol, the server, the data

These pages are rendered from the markdown in the repository at build time, so they describe the code as it is on main. Every page links back to its source file.

Puls Sync Protocol v1

The wire protocol the app speaks, written for anyone implementing a receiver: transport, the NDJSON batch, every line type, canonical units, idempotency and the retry contract.

docs/protocol/README.md

Read

Self-hosting the reference server

Running the Docker Compose stack: services and ports, configuration, schema migrations, tokens, exposing ingest, backups and the product API.

server/README.md

Read

Use it with AI assistants

Connecting Claude Desktop, Claude Code, Cursor or a ChatGPT Action to your own data through the read-only MCP server, and what each tool answers.

docs/ai.md

Read

Bulk export

Pulling a whole range of one dataset as streamed CSV or JSONL over GET /v1/export, with curl or the puls-export CLI.

docs/export.md

Read

Data and schema guide

What the database stores and how to query it without misreading the health data: every table family, the derived views, and the device double-counting trap.

docs/database-guide.md

Read

Not everything is rendered here. The JSON Schemas, the fixture corpus, the type catalog, the Swift package and the MCP server each have their own README next to the code. Browse the repository