Skip to main content
Use this guide to install synheart-cli using the official installer scripts.
synheart-cli is used for two core developer tasks: installing Synheart SDK artifacts and testing apps locally with mock data/local services.

​
Install by Platform

​
Install with PowerShell

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

​
Add to PATH (Windows)

If synheart is not recognized after install, add the install directory to your PATH.Common install location:
  • $env:USERPROFILE\.synheart\bin
Current PowerShell session:
$env:Path += ";$env:USERPROFILE\.synheart\bin"
Persist for future sessions:
setx PATH "$env:PATH;$env:USERPROFILE\.synheart\bin"

​
PATH Setup for macOS/Linux

Use one of the common install directories below if the installer output does not already print/export it:
  • $HOME/.synheart/bin
  • $HOME/.local/bin
For bash: 
echo 'export PATH="$HOME/.synheart/bin:$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
For zsh: 
echo 'export PATH="$HOME/.synheart/bin:$HOME/.local/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc
For fish: 
set -U fish_user_paths $HOME/.synheart/bin $HOME/.local/bin $fish_user_paths

​
Verify Installation

Run: 
synheart version
synheart --help
command -v synheart
If installed correctly, you should see the CLI command help output.

​
Download SDK Artifacts

After installing the CLI, authenticate and install SDK artifacts into your project: 
synheart login
synheart install core
synheart sync
synheart env
Useful options: 
synheart install core --platform android
synheart install core --channel latest
synheart install runtime --channel latest
synheart install writes synheart.lock; synheart sync installs exactly what the lockfile pins.

​
Local App Testing

Start a mock stream: 
synheart mock start
Enable HSI transformation with Flux: 
synheart mock start --flux
Run local platform endpoints for offline consent/ingest integration testing: 
synheart local

​
Troubleshooting

Ensure the CLI install directory is in your PATH, then restart your terminal. On Windows, re-open PowerShell after running setx. On macOS/Linux, reload your shell profile (source ~/.bashrc or source ~/.zshrc).
Confirm your environment can access https://synheart.sh and re-run the installer command.
Run command -v synheart (or Get-Command synheart on PowerShell) to check which binary is first in PATH.