Skip to content
SimanticDashboard

Meet your virtual hardware.

Simantic runs your firmware on simulated MCUs, so you can observe and debug your system without a physical board.

Simulator access is by approval

You need an approved account to run firmware. Before spending time on installation or account setup, email us to request access and tell us which hardware you want to simulate.

Already approved? Sign in to open the full simulation documentation.

Installation

Run the installer, which downloads the zip for your platform, verifies its checksum, extracts the sim binary to ~/.local/bin, and hands off to sim login if the shell is interactive. An existing install can also update itself with sim update (see Updating).

curl -fsSL https://simantic.dev/install | sh

Published platforms are linux-x64 and osx-arm64. Pass --check to print the latest version without installing, or -h for the full option list.

Install via Homebrew

brew tap simantic-dev/simantic
brew install simantic

Installs the same sim binary as the script above. Sign in with sim login after installing, and use brew upgrade simantic to update.

Authentication

Create an API key

  1. Sign in and open Account → API Settings.
  2. Enter a name for the token, then select Create token.
  3. Copy the token immediately. The full key is shown only once.

An API key identifies your account. Creating one does not grant simulator access; running firmware still requires approval.

Sign in from the CLI

Use the browser sign-in flow for an interactive terminal:

sim login

For manual setup with an API key, use sim auth.

The auth command prompts for your email and personal access token and writes them to ~/.sim_id (mode 0600 on Unix).

sim auth
# Email: you@example.com
# API key: smtc_xxxxxxxxxxxxxxxx
# Credentials saved for you@example.com

The API key prompt hides input on a TTY (echoes nothing while you type). If stdin is redirected, it falls back to a normal line read.

The token must start with smtc_. The file format is:

EMAIL=you@example.com
API_KEY=smtc_xxxxxxxxxxxxxxxx

Replace or revoke a key

Open API Settings and select Revoke for the key, then confirm. If you lose a key, create a replacement and run sim auth again with it.

Keep keys out of source control and shared logs. If authentication fails, check that the key starts with smtc_, has not been revoked, and belongs to the email you entered.

Updating

The update command updates the installed sim binary in place to the latest released version. It reads the published latest.json manifest, compares it against the running binary's version, and — if newer — downloads the build for your platform, verifies its SHA-256, and atomically swaps the running executable.

sim update          # install the latest release if one is available
sim update --check  # report whether a newer version exists, without installing
  • Replaces the file at the running executable's path.
  • Supported on the published platforms only (linux-x64, osx-arm64); other platforms print a message and exit non-zero.
  • Never downgrades — a release will not replace a newer or equal local version.
  • Makes no backend or credential calls; it only reads the public release bucket. If sim lives in a system location, run with sufficient permissions to overwrite it.