synheart local
Run a local copy of the Synheart platform
Starts an HTTP server on your machine that answers the platform endpoints
your SDK calls, so you can develop and test without network access:
Subcommands
synheart local cleanup: Undo the setup that local —https made
synheart local cleanup
Undo the setup that local —https made
Removes the ”# synheart” entries that ‘synheart local —https’ added to
/etc/hosts. Add —remove-certs to also delete the locally generated
certificates and stop trusting the local CA. Removing hosts entries may need
elevated permissions. Needs no login and no network. Progress goes to stderr.
Usage
Examples
synheart mock
Generate and replay mock wearable data
Generates, records and replays mock HSI sensor data, so you can build
against the Human State Interface without a wearable. Needs no login and no
network.
‘synheart mock’ on its own prints this help; use the subcommands to run it.
For the guided mock flow, open ‘synheart ui’.
Usage
synheart mock describe: Show a scenario’s signals and phasessynheart mock list-scenarios: List the available mock scenariossynheart mock record: Record mock wearable data to a filesynheart mock replay: Replay a recorded mock sessionsynheart mock start: Stream mock wearable data to your app
synheart mock describe
Show a scenario’s signals and phases
Prints one scenario in detail: its duration, default rate, the signals it
generates with their baselines, noise and units, and its phases with any
overrides. Use it to choose a scenario before you run it. Needs no login and no
network. With —json it prints the same details as an object.
Usage
scenario, scen
Examples
--json (or --format json) to print a machine-readable body.
synheart mock list-scenarios
List the available mock scenarios
Lists every scenario that ‘synheart mock start’ and ‘mock record’ can run,
each with a one-line description. Use it to find a scenario name. Needs no
login and no network. With —json it prints an object with an “items” array of
name and description.
Usage
scenarios, ls
Examples
--json (or --format json) to print a machine-readable body.
synheart mock record
Record mock wearable data to a file
Generates sensor events for a scenario and writes them to an NDJSON file
without serving them, so you can replay the same session later with
‘synheart mock replay’. Pass —seed to get the same data every time. Needs no
login and no network.
Scenario and vendor fall back to the mock section of .synheart/config.yaml when
you do not pass them.
Usage
Examples
synheart mock replay
Replay a recorded mock session
Reads a recording made with ‘synheart mock record’ (or ‘mock start —out’)
and serves its events over WebSocket on —port, with the original timing scaled
by —speed. Use it to run the same session against your app again and again.
Needs no login and no network. Press Ctrl+C to stop.
Host and port fall back to the mock section of .synheart/config.yaml when you
do not pass them.
Usage
Examples
synheart mock start
Stream mock wearable data to your app
Generates sensor events for a scenario and serves them over WebSocket (on
—port), Server-Sent Events (—port plus 1) and UDP (—port plus 2) until you
press Ctrl+C or —duration ends. Connect your app’s SDK to one of them.
Use —vendor garmin for Garmin-format payloads (the default is whoop), —out
to record the stream as NDJSON, and —web to open a live dashboard in your
browser. Port, host, scenario and vendor fall back to the mock section of
.synheart/config.yaml when you do not pass them. Needs no login and no
network.
Usage
Examples
synheart receiver
Receive HSI export payloads over HTTP
Starts an HTTP server that accepts HSI export payloads POSTed to
/v1/hsi/import, for example from the Synheart Life app over your local network.
Each payload is checked against the HSI Export Schema v1, duplicates are
ignored, and the data is written to stdout or, with —out, to files. Runs until
you press Ctrl+C.
Senders must present a bearer token: pass —token, or let it generate one.
It listens on every network interface by default; use —host 127.0.0.1 to keep
it on this machine. Host, port and out fall back to the receiver section of
.synheart/config.yaml. Needs no login.
Usage
Examples