Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.synheart.ai/llms.txt

Use this file to discover all available pages before exploring further.

The Synheart Runtime (synheart-core-runtime) is the native engine that performs on-device human-state inference. The Synheart Core SDK loads it across the native bridge at startup, so it must be installed in your project before you initialize Core.
The runtime is required for Synheart Core. Standalone use of synheart_wear, synheart_behavior, or synheart_session does not require the runtime — see Quickstart for the standalone tracks.

​
Install

From your project root: 
synheart install runtime
This:
  • Downloads the runtime artifact for your project’s platforms.
  • Writes a synheart.lock file pinning the exact versions.
  • Places the native binaries where the Core SDK expects them.

​
Channels and versions

# Install from the latest channel (default)
synheart install runtime --channel latest

# Install a specific version (versions are v-prefixed)
synheart install runtime --version v1.2.3

# Restrict to a single platform
synheart install runtime --platform ios       # ios | android
A stable channel is reserved but not yet published. latest is the only channel currently in use. The --platform flutter value is currently a no-op — runtime artifacts are published per native target.

​
Override the registry / CDN

SYNHEART_API_URL=https://api.staging.example.com synheart install runtime
SYNHEART_DIST_URL=https://dist.staging.example.com synheart install runtime

​
Reproducible installs

After the first install, commit synheart.lock to your repo. Anyone else on the project (and CI) installs the same versions with: 
synheart sync

​
Inspect environment

synheart env
synheart env --format json
Prints install paths, runtime version, and detected project type.

​
Next

Build your first integration

Initialize Synheart Core and start receiving HSI updates.