Skip to main content
The Synheart CLI is the developer command-line interface for the Synheart ecosystem. It is used to:
  • Download and sync Synheart SDK/runtime artifacts into your project
  • Generate local mock wearable streams for app development and QA
  • Run local platform endpoints for consent and ingest testing
  • Receive HSI exports from Synheart Life over your local network
This makes synheart-cli the main local-development bridge between SDK delivery and app testing.
Installation steps are maintained in the Tools section: Install Synheart CLI.
Synheart CLI vs Wear CLI: synheart-cli is for local simulation/testing and SDK artifact workflows. For real cloud wearable streaming (WHOOP, Garmin, Fitbit), use Wear CLI.

​
Developer Workflows

SDK Artifact Install

Authenticate, install SDK artifacts, and lock/sync exact versions across machines.

Local App Testing

Generate mock Whoop/Garmin payloads and optional HSI output over WebSocket/SSE/UDP.

Offline Platform

Run local consent+ingest endpoints and receive HSI exports from mobile apps.

​
Command Groups

GroupCommandsPurpose
SDK managementlogin, logout, whoami, install, sync, envAuth + deterministic SDK artifact installation
Mock simulationmock start, mock record, mock replay, mock list-scenarios, mock describeLocal sensor stream generation and replay
Local serviceslocal, receiverOffline platform testing and mobile export intake
Diagnosticsdoctor, versionEnvironment validation and runtime metadata

​
SDK Artifact Workflow

Use this flow when bootstrapping or updating SDK artifacts in app repos: 
synheart login
synheart install core
synheart sync
synheart env

​
Install specific channels or platforms

synheart install core --channel latest
synheart install core --version 1.2.3
synheart install core --platform android
synheart install runtime --channel latest
synheart install writes a synheart.lock; synheart sync reinstalls exactly what the lockfile pins.

​
Local Testing Workflow

Start local streams for app/dev testing: 
synheart mock start
synheart mock start --flux
Default endpoints:
  • WebSocket: ws://127.0.0.1:8787
  • SSE: http://127.0.0.1:8788/events
  • UDP: 127.0.0.1:8789
synheart mock start --vendor garmin --flux --scenario workout
synheart mock start --flux --flux-verbose
synheart mock record --vendor whoop --flux --duration 15m --out session.ndjson
synheart mock replay --in session.ndjson --speed 2.0 --loop

​
Local Platform and Receiver

synheart local
synheart local --port 9000 --api-key my-key --hmac-secret my-secret
synheart receiver
synheart receiver --out ./exports --format ndjson

​
Scenario Inspection

synheart mock list-scenarios
synheart mock describe baseline

​
Diagnostics

synheart doctor
synheart version
synheart whoami
synheart env --format json

​
Troubleshooting

Run synheart login first. Artifact commands require a valid access token.
Use --port with synheart mock start or check availability with synheart doctor --port 8787.
Commit synheart.lock and run synheart sync in CI to install pinned artifacts.
Author: Israel Goytom