Install Modeler CLI

Syside Modeler CLI ships as an archive you extract and add to your PATH, on Windows, macOS, Linux or in Docker. It needs a Modeler license, available on Sensmetry.com. If you have already activated one for Modeler or Automator on this machine, the CLI finds it in your keyring and there is nothing more to do.

Install CLI

Download Modeler CLI for the machine that will run it:

  1. Extract the .zip file to %LOCALAPPDATA%\Programs\Syside (create the folder if it doesn’t exist)

  2. Add to PATH via Environment Variables:

    1. Open “Environment Variables” (search in Start menu)

    2. Under “User variables”, select “Path” and click “Edit”

    3. Click “New” and add %LOCALAPPDATA%\Programs\Syside

    4. Click “OK” to save

Alternatively, both steps as PowerShell commands:

# Create directory and extract
mkdir "$env:LOCALAPPDATA\Programs\Syside" -Force
tar -xf syside-<version>-x86_64-windows.zip -C "$env:LOCALAPPDATA\Programs\Syside"

# Add to PATH
$currentPath = [Environment]::GetEnvironmentVariable("Path", "User")
$newPath = "$env:LOCALAPPDATA\Programs\Syside"
if ($currentPath -notlike "*$newPath*") {
   [Environment]::SetEnvironmentVariable("Path", "$currentPath;$newPath", "User")
}

Restart your terminal afterwards, so the PATH change takes effect.

  1. Open the downloaded .dmg file and drag Syside.app to /Applications/

  2. Create a symlink to run syside from anywhere:

    mkdir -p ~/.local/bin
ln -sf /Applications/Syside.app/Contents/MacOS/syside ~/.local/bin/syside

  3. Add ~/.local/bin to your PATH by adding this line to ~/.zshrc:

    export PATH="$HOME/.local/bin:$PATH"

  4. Reload your shell configuration:

    source ~/.zshrc

  1. Extract the downloaded .tar.xz file to ~/.local:

    mkdir -p ~/.local
tar -xJf syside-<version>-x86_64-linux-glibc.tar.xz --directory ~/.local

  2. Add ~/.local/bin to your PATH by adding this line to ~/.bashrc:

    export PATH="$HOME/.local/bin:$PATH"

  3. Reload your shell configuration:

    source ~/.bashrc

Docker runs Modeler CLI on any host, including Apple silicon Macs.

  1. Create a Dockerfile:

    FROM debian:trixie-slim

ADD syside-<version>-x86_64-linux-glibc.tar.xz /usr/local/lib/syside

RUN ln -s /usr/local/lib/syside/syside /usr/local/bin/syside

  2. Place the Linux .tar.xz archive next to it. The container runs Linux, so use the Linux archive even on a Mac or Windows host.

  3. Build and run:

    docker build -t syside .
docker run --rm --platform linux/amd64 -it -v $(pwd):/app -w /app syside /bin/bash

    The --platform linux/amd64 flag ensures the container runs correctly on ARM-based hosts, such as Apple silicon Macs. It is safe to include on x64 hosts as well.

Activate license

Modeler CLI checks the license with our licensing servers as you run it. Licensing covers what that needs, and What data we collect lists what is sent and what you can turn off.

Store the license key in one of the following locations, or import a license file where the servers are unreachable. Keep the key private: an exposed key risks unauthorized use or revocation of the license.

On a desktop, the operating system’s secret storage (Windows Credential Store, macOS Keychain, or GNOME Keyring on Linux) holds the key per user, for every project, outside code and configuration.

With Modeler, open the Command Palette (Ctrl/Cmd+Shift+P) and run Syside Modeler: Add Syside license key to keyring. The command copies the key Modeler holds, or asks for one when Modeler has none yet.

Without Modeler, store it with the syside-license tool, which needs Python 3.12 or newer and asks for the key:

uvx syside-license keyring store

pip install syside-license
syside-license keyring store

For local development, create a .env file in the project root containing your license key:

SYSIDE_LICENSE_KEY=<your-license-key>

Add .env to your .gitignore so the key is never committed.

Set SYSIDE_LICENSE_KEY in the shell you run Syside from. The setting lasts only for that shell session. To make it permanent, set it in your shell’s profile or your system’s environment settings. It is also the route where there is no secret storage, such as a Docker container or WSL.

On Windows (PowerShell):

$env:SYSIDE_LICENSE_KEY = "<your-license-key>"

On macOS or Linux:

export SYSIDE_LICENSE_KEY=<your-license-key>

A pipeline takes the Business plan’s CI/CD license. Store it as SYSIDE_LICENSE_KEY: in GitLab as a masked CI/CD variable, in GitHub as a repository secret.

On a machine that cannot reach our licensing servers, import a license file instead: Offline license covers getting, carrying over and importing it.

Verify installation

In a new terminal, check that the command is found:

syside --version

You should see the installed version followed by its build hash.

Continue to Quickstart, or start at Troubleshooting if something did not work.

Update CLI

Updating keeps your license activation. Modeler CLI does not update itself: repeat the installation steps with the latest version.