> ## 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.

# 1. Install the CLI

> Install synheart-cli on macOS, Linux, or Windows

`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

<Tabs>
  <Tab title="macOS / Linux">
    ```bash theme={null}
    curl -fsSL https://synheart.sh/install | sh
    ```
  </Tab>

  <Tab title="Windows (PowerShell)">
    ```powershell theme={null}
    iwr -useb https://synheart.sh/install.ps1 | iex
    ```
  </Tab>
</Tabs>

## 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.

<Tabs>
  <Tab title="bash">
    ```bash theme={null}
    echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
    source ~/.bashrc
    ```
  </Tab>

  <Tab title="zsh">
    ```bash theme={null}
    echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
    source ~/.zshrc
    ```
  </Tab>

  <Tab title="fish">
    ```bash theme={null}
    set -U fish_user_paths $HOME/.local/bin $fish_user_paths
    ```
  </Tab>

  <Tab title="Windows">
    ```powershell theme={null}
    setx PATH "$env:PATH;$env:LOCALAPPDATA\synheart\bin"
    ```

    Restart PowerShell after running `setx`.
  </Tab>
</Tabs>

## Verify

```bash theme={null}
synheart version
synheart --help
```

If both commands print output, the CLI is installed.

## Next

<Card title="Create a platform account" icon="user-plus" href="/setup/create-account">
  Synheart is currently invite-only. Request access to continue.
</Card>