Skip to main content
Every command also accepts the global flags.

​
synheart install

Install SDK artifacts into your project Downloads Synheart SDK artifacts from the Artifact Registry into your project’s synheart/vendor directory and records them in synheart.lock. Use it to add the runtime or the Syni packages to an app, or to change runtime variant. Needs: you are logged in (‘synheart login’), network access, and a project directory (default: the current directory). For a guided install, open ‘synheart ui’. Products are syni and core; components are runtime and spec. A product installs every component of it that your plan includes. A component installs across every product that ships it. Two arguments, in either order, pin one package. Files go to synheart/vendor/runtime/ for the core runtime and to synheart/vendor/<package>/ for everything else. Usage
Flags Examples
JSON output: supported. Add --json (or --format json) to print a machine-readable body.

​
synheart runtime

Manage the synheart-core-runtime library Inspect, upgrade, or install the native synheart-core-runtime library in a project. The runtime is what your app’s Synheart SDK loads at launch. To fetch the runtime from the registry the first time, use ‘synheart install runtime’. The subcommands here work on a runtime that is already pinned in synheart.lock, or on a local build. Usage
Subcommands
  • synheart runtime current: Show the runtime pinned in synheart.lock
  • synheart runtime install: Install runtime artifacts from a local build
  • synheart runtime upgrade: Fetch the latest runtime for your variant
Examples

​
synheart runtime current

Show the runtime pinned in synheart.lock Prints the runtime package, variant and version recorded in the project’s synheart.lock. It makes no network call, so it is a quick way to answer “what am I on?”. Needs a project directory containing synheart.lock (default: the current directory). Exits 1 with SH-RT-NOLOCK when there is no lockfile yet. With —json it prints the same fields as an object. Usage
Flags Examples
JSON output: supported. Add --json (or --format json) to print a machine-readable body.

​
synheart runtime install

Install runtime artifacts from a local build Copies pre-built synheart-core-runtime artifacts from a local build directory into <project>/synheart/vendor/runtime/, in the same layout that ‘synheart install runtime’ produces from the registry. Use it to test a runtime you built yourself. No login or network needed. —from points at the build output, typically from ‘make dist-core’ in the synheart-core-runtime repository. Everything at the top level of that directory is copied as is. Usage
Flags Examples
JSON output: not supported. This command does not print a JSON body.

​
synheart runtime upgrade

Fetch the latest runtime for your variant Reads the variant (edge, stable or lab) from synheart.lock and runs ‘synheart install runtime’ against the latest release of that variant. A project on lab stays on lab; a project on edge stays on edge. With no lockfile it installs without a variant, so the server picks one from your plan. Needs: you are logged in and network access. Usage
Flags Examples
JSON output: not supported. This command does not print a JSON body.

​
synheart sync

Reinstall exactly what synheart.lock pins Reads synheart.lock in the project directory and installs the versions it pins, so every machine and CI run gets the same artifacts. Use it after cloning a project or pulling a lockfile change. It works with single-package and multi-package lockfiles. Needs: you are logged in, network access, and a synheart.lock (created by ‘synheart install’). Usage
Flags Examples
JSON output: supported. Add --json (or --format json) to print a machine-readable body.