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.

To build with Synheart Core, complete these four steps in order. Standalone use of synheart_wear, synheart_behavior, or synheart_session only requires their package — skip ahead to the Quickstart for those tracks.
1

Install the CLI

curl -fsSL https://synheart.sh/install | sh — see Install the CLI.
2

Create a platform account

Synheart is invite-only. Request access, then sign up at platform.synheart.ai. See Create a platform account.
3

Authenticate the CLI

synheart login signs the CLI in via OAuth Device Flow. See Authenticate the CLI.
4

Install the runtime

synheart install runtime downloads the native HSI engine into your project. See Install the runtime.
Once setup is complete, jump to the Quickstart to initialize a Core SDK and start receiving HSI updates.