synheart config
Show how the CLI resolves its settings
The CLI resolves each setting in this order, highest first:
synheart config path: Print the path of the project config filesynheart config show: Show the resolved project configuration
synheart config path
Print the path of the project config file
Prints the absolute path of the .synheart/config.yaml in effect. When none
is found it prints “(none)” and exits 1, so you can use it in a shell
conditional. With —json it prints “loaded” and “config_path”.
Usage
--json (or --format json) to print a machine-readable body.
synheart config show
Show the resolved project configuration
Prints the config files in effect (the project config found by searching up
from the current directory, and the user config ~/.synheart/config.yaml), the
appearance settings with the layer each came from (flag, env, project, user or
default), and the values the project sets for mock, local, receiver and
scenarios. Needs no login and no network. With —json it prints the same as an
object.
Usage
--json (or --format json) to print a machine-readable body.
synheart doctor
Check your Synheart setup for problems
Walks through your environment, scenario data, installed runtime, sign-in
and network, and reports each step as ok, warn or error. The runtime check
reads synheart.lock: vendored files must still match it, and native libraries
must export the functions their variant needs. In a Flutter project it also
checks that the runtime satisfies the synheart_core version your project
resolved.
Doctor exits 1 only when your app cannot work: the runtime is missing or
incompatible, its files are missing or modified, or a library lacks functions
its variant must export. Everything else, such as a port in use, an available
update or being logged out, is reported without changing the exit code.
—online also asks the registry for a newer runtime and needs you to be logged
in. With —json it prints the report as an object.
Usage
Examples
--json (or --format json) to print a machine-readable body.
synheart env
Show paths, account and project type
Prints what support or an agent needs to know about your setup: Go version,
OS and architecture, cache and config paths, the project’s lockfile and vendor
directory, the detected project type (ios, android, flutter, multi or none) and
app IDs, the signed-in account and plan, and the pinned runtime from
synheart.lock. Needs no network; the account section appears only when you are
logged in. With —json it prints the same as an object.
Usage
Examples
--json (or --format json) to print a machine-readable body.
synheart explain
Read a plain-language primer on a concept
Prints a short primer on a Synheart concept, such as HSI or HRV, in your
terminal. Run it with no topic to list the available topics. Needs no login and
no network. With —json it prints the topic (title, summary, body, examples) as
an object, or the topic list as an object with “items”.
Usage
--json (or --format json) to print a machine-readable body.
synheart update
Update the CLI to the latest release
Checks the release manifest, and if a newer version exists, asks you to
confirm and then replaces the running binary. Use —check to only report
whether an update exists (exit 0 if you are current, 1 if a newer one is
available), —yes to skip the prompt in scripts, and —rollback to restore the
binary you had before your last update.
Refuses when a package manager (Homebrew, apt, Chocolatey, go install) manages
the binary; use —force to override, or update with the package manager. On
Windows, re-run the installer instead. Needs network access.
After other commands the CLI prints a one-line notice when an update is
available. Silence it with SYNHEART_NO_UPDATE_CHECK=1 or by running in CI. With
—json it prints the result as an object. ‘synheart upgrade’ is an alias.
Usage
upgrade
Flags
Examples
--json (or --format json) to print a machine-readable body.
synheart version
Show the CLI version
Prints the CLI version. Add —build for the commit, build date, Go version
and OS and architecture; include them when you file a bug. Needs no login and no
network. With —json it always prints every field as an object.
Usage
Examples
--json (or --format json) to print a machine-readable body.