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.

synheart-cli is the entry point for working with the Synheart platform. It installs the on-device runtime, runs a local mock platform, generates wearable data, and authenticates you against platform.synheart.ai.

​
Install

curl -fsSL https://synheart.sh/install | sh

​
Add to PATH

The installer prints the install directory it chose. Defaults — ~/.local/bin on macOS / Linux and %LOCALAPPDATA%\synheart\bin on Windows. Override either default with the SYNHEART_INSTALL_DIR environment variable before running the installer. If synheart is not found after install, add the install directory to your shell profile. 
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

​
Verify

synheart version
synheart --help
If both commands print output, the CLI is installed.

​
Next

Create a platform account

Synheart is currently invite-only. Request access to continue.