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

# Command reference

> Every synheart command, grouped the way `synheart --help` groups them.

This reference is generated from synheart 0.19.0. For a machine-readable version, run `synheart help --json`.

## Command groups

### [Build your app](/cli/reference/build-your-app)

* `synheart install`: Install SDK artifacts into your project
* `synheart runtime`: Manage the synheart-core-runtime library
* `synheart sync`: Reinstall exactly what synheart.lock pins

### [Simulate & serve](/cli/reference/simulate-and-serve)

* `synheart local`: Run a local copy of the Synheart platform
* `synheart mock`: Generate and replay mock wearable data
* `synheart receiver`: Receive HSI export payloads over HTTP

### [Platform](/cli/reference/platform)

* `synheart api-key`: List and manage API keys
* `synheart auth`: Sign in, sign out and inspect credentials
* `synheart login`: Sign in to your Synheart account
* `synheart logout`: Sign out and remove stored credentials
* `synheart org`: List and manage your organizations
* `synheart project`: List and manage your projects
* `synheart usage`: Show plan usage, limits and Syni meters
* `synheart whoami`: Show the account you are signed in as

### [AI & agents](/cli/reference/ai-and-agents)

* `synheart guard`: Hold your coding agents to rules you set
* `synheart mcp`: Connect AI agents through the MCP server
* `synheart syni`: Chat with Syni, Synheart's state-aware assistant

### [Troubleshoot](/cli/reference/troubleshoot)

* `synheart config`: Show how the CLI resolves its settings
* `synheart doctor`: Check your Synheart setup for problems
* `synheart env`: Show paths, account and project type
* `synheart explain`: Read a plain-language primer on a concept
* `synheart update`: Update the CLI to the latest release
* `synheart version`: Show the CLI version

### [Other](/cli/reference/other)

* `synheart completion`: Generate a shell completion script
* `synheart ui`: Open the interactive terminal UI

## Global flags

Every command accepts these flags.

| Flag | Type | Default | Description |
| - | - | - | - |
| `--format` | `string` | `text` | Output format: text, json or ndjson (event stream, on commands that stream); agent mode defaults to json |
| `--json` | `bool` | `false` | Shorthand for --format json |
| `--no-color` | `bool` | `false` | Turn off coloured output |
| `-q`, `--quiet` | `bool` | `false` | Hide non-essential output |
| `--theme` | `string` | - | Colour theme: tide\|ember\|signal\|mono (default tide; also SYNHEART\_THEME) |
| `-v`, `--verbose` | `bool` | `false` | Print extra diagnostic output |

## Exit codes

| Code | Meaning |
| - | - |
| `0` | success |
| `1` | general failure |
| `2` | usage error: bad flags or arguments, unknown command |
| `3` | authentication required or forbidden (SH-AUTH-\*) |
| `4` | the requested resource was not found |
| `5` | transient failure (network, timing); retrying may work |

## Environment variables

| Variable | Description |
| - | - |
| `SYNHEART_AGENT` | 1 forces agent mode on, 0 forces it off |
| `CLAUDECODE` | agent mode: set to 1 by Claude Code in the shells it spawns |
| `CLAUDE_CODE_ENTRYPOINT` | agent mode: set by Claude Code to how it was launched |
| `CURSOR_AGENT` | agent mode: set to 1 by Cursor's agent terminal |
| `CODEX_SANDBOX` | agent mode: set by OpenAI Codex when it runs commands in its sandbox |
| `GEMINI_CLI` | agent mode: set to 1 by Gemini CLI's shell tool |
| `COPILOT_AGENT` | agent mode: set by GitHub Copilot's coding agent |
| `SYNHEART_NO_TUI` | 1 disables the interactive TUI |
| `SYNHEART_MOUSE` | 1 lets the TUI capture the mouse for wheel scrolling (selecting text then needs Shift or Option) |
| `SYNHEART_NO_UPDATE_CHECK` | 1 disables the passive update notice |
| `SYNHEART_THEME` | colour theme (same as --theme) |
| `SYNHEART_API_URL` | override the platform API base URL |
| `SYNHEART_CI_TOKEN` | long-lived token for non-interactive login |
| `NO_COLOR` | any value disables colour |
| `CI` | any value disables the TUI and update notices |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.