1. Install the CLI

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

Homebrew (macOS / Linux)
winget (Windows)
Install script

brew tap synheart-ai/tap
brew trust synheart-ai/tap   # Homebrew 7 and later install only from taps you trust
brew install synheart

Upgrade with brew upgrade synheart.

winget install --id SynheartAI.Synheart

Upgrade with winget upgrade --id SynheartAI.Synheart.

macOS and Linux:

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

Windows (PowerShell):

iwr -useb https://synheart.sh/install.ps1 | iex

Upgrade with synheart update.

Homebrew and winget put synheart on your PATH for you. With either one, skip the next section.

Add to PATH (install script only)

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.

bash
zsh
fish
Windows

echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

set -U fish_user_paths $HOME/.local/bin $fish_user_paths

setx PATH "$env:PATH;$env:LOCALAPPDATA\synheart\bin"

Restart PowerShell after running setx.

Verify

synheart version
synheart --help

If both commands print output, the CLI is installed.

Get Started

Security

Setup

CLI

Synapse

Platform

HSI

Synheart Wear

Synheart Auth

Synheart Core

Synheart Behavior

Syni

Syni Spec

Synheart Session

RAMEN 🍜

Lab Mode

Privacy

Guides

Install

Add to PATH (install script only)

Verify

Next

Create a platform account