Offline Installation

This guide provides instructions for installing Syside tools in network-isolated or air-gapped environments. This is targeted for enterprise users who have strict network security policies, company proxy restrictions, or air-gapped environments that prevent direct access to online package repositories and licensing servers.

Setup Prerequisites

  • A computer with internet access to download files

  • The offline computer/workstation where Syside is needed

  • A means to transfer downloaded files (USB drive, shared network drive, etc.)

Note

Offline installation requires a Business plan license that supports fully network-isolated operation. See Syside Pricing for details.

Minimum Requirements

Network Computer:

  • System requirements:

    • Windows 10+ x64 (for older versions, install Windows UCRT)

    • macOS Big Sur (11.0+, arm64) / High Sierra (10.13+, x64)

    • Linux x64 distribution with GNU C Library glibc >= 2.31

  • Software requirements (License generation):

Target Computer:

  • System requirements:

    • Windows 10+ x64 (for older versions, install Windows UCRT)

  • System requirements:

    • macOS Big Sur (11.0+, arm64)

    • macOS High Sierra (10.13+, x64)

  • System requirements:

    • Linux x64 distribution with GNU C Library glibc >= 2.31

    Note

    Some Linux distributions like Alpine and Chimera do not include glibc and may not support running applications that require it.

    How to check your glibc version

    1. Using gcc:

      $(cat $(gcc -print-file-name=libc.so) | grep -P '/[^\s]+/libc\.so\.[\w]+' -o)

      You should see output similar to: GNU C Library (GNU libc) stable release version 2.40

    2. Using Python:

      python -c "import platform; print(platform.platform())"

      You should see output similar to (glibc should be printed at the end): Linux-6.13.7-3-cachyos-x86_64-with-glibc2.41

Preparation on Network Computer

Before installing on your target computer, download the necessary files on a computer with internet access. You only need to download the products you plan to use - all products share the same license file, so you only need to generate it once.

Download Files

  1. Download syside-license tool using pip (see Python Packaging User Guide):

    pip download syside-license

    This will download syside_license-*.whl file to your current directory.

  2. Download Syside tools:

    Download Syside Modeler extension for your target platform:

    Other platforms: Windows | macOS (Intel) | macOS (ARM) | Linux

    Warning

    The offline .vsix file differs from the VS Code Marketplace version. Download the offline-compatible version above, which includes bundled dependencies.

    Download Syside Modeler CLI for your target platform:

    Other platforms: Windows | macOS (Intel) | macOS (ARM) | Linux

    Download Syside Automator for your target platform using pip:

    pip download syside

    This will download syside-*.whl, click-*.whl, and colorama-*.whl (Windows only) files to your current directory.

Cross-Platform Downloads

If downloading for a different platform (e.g., Windows → Linux), add --only-binary=:all: --platform <platform> options to the pip download command.

Platform

Description

macosx_11_0_arm64

ARM Macs

macosx_10_13_x86_64

Intel Macs

win_amd64

Windows

manylinux_2_31_x86_64

Linux

Example: Downloading for Linux while on Windows:

pip download syside --only-binary=:all: --platform manylinux_2_31_x86_64

Generate License File

All Syside tools (Modeler, Modeler CLI, and Automator) share the same license file that can be generated using the syside-license tool:

  1. Open a terminal and create a Python virtual environment

    python -m venv .venv

  2. Activate the created virtual environment (see How to manually activate virtual environment)

  3. Install the Syside license tool:

    pip install syside-license

    You should see output similar to: Successfully installed syside-x.x.x

  4. Generate the license file:

    syside-license check --license-key <LICENSE-KEY> --output syside-license.lic

    This creates a file called syside-license.lic in the current directory.

How to manually activate virtual environment

  1. Run the following command in the terminal:

    1. Using Command Prompt:

      .\.venv\Scripts\activate

    2. Using PowerShell:

      .\.venv\Scripts\Activate.ps1

      PowerShell may block the activation with a “scripts disabled” error. Run the following command to allow script execution:

      Set-ExecutionPolicy Bypass -Scope Process -Force

  2. Run the following command to verify that the virtual environment was successfully activated:

    where.exe python

    The printed path should end with: /.venv/bin/python

  1. Run the following command in the terminal:

    source .venv/bin/activate

  2. Run the following command to verify that the virtual environment was successfully activated:

    which python

    The printed path should end with: /.venv/bin/python

Note

If you have trouble generating the license file, contact support at syside.support@sensmetry.com with your license key.

Installation on Target Computer

Transfer Files

Transfer the downloaded files to the target computer using a USB drive, shared network drive, or other secure transfer method:

File

Description

syside-license.lic

License file (required for all products)

syside-modeler-*.vsix

Modeler installer

syside-*.zip, syside-*.dmg, syside-*.tar.xz

Modeler CLI install archive: .zip (Windows), .dmg (macOS), or .tar.xz (Linux)

syside-*.whl, syside_license-*.whl, click-*.whl, colorama-*.whl

Automator install files

Install Tools

  1. Open Visual Studio Code or your preferred VSCodium-based editor

  2. Install the extension:

    1. via Extensions view:

      1. Click in left sidebar or press Ctrl/Cmd-Shift-X

      2. Drag and drop the syside-modeler-*.vsix file to the Extensions panel (alternatively, click … and Install from VSIX…)

    2. via Command Palette:

      1. Open the Command Palette Ctrl/Cmd-Shift-P

      2. Type Extensions: Install from VSIX…

      3. Select the downloaded .vsix file and click Install

Option A: Manual Installation

  1. Extract the .zip file to %LOCALAPPDATA%\Programs\Syside

  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

Option B: PowerShell Installation

Run these commands in PowerShell:

# Create directory and extract
mkdir "$env:LOCALAPPDATA\Programs\Syside" -Force
tar -xf syside-0.8.1-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")
}

Note

Restart your terminal after installation for PATH changes to take effect.

Version History

  • v0.8.2: Syside bundle was renamed from SysIDE.app to Syside.app.

  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 -s ~/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

  1. Open a terminal and create a Python virtual environment:

    python -m venv .venv

  2. Activate the created virtual environment (see How to manually activate virtual environment)

  3. Place all .whl files in the same directory

  4. Install packages from the wheels:

    pip install syside-license syside --find-links "<path/to/wheels/directory>"

Import License

After installing your tools, you need to import the syside-license.lic file. This step is common for all Syside products.

  1. Open Visual Studio Code or your preferred VSCodium-based editor

  2. Open the Command Palette Ctrl/Cmd-Shift-P

  3. Type Syside Modeler: Import Syside license

  4. Select the syside-license.lic file

  1. Open a new terminal

  2. Activate the Python virtual environment with Automator (see How to manually activate virtual environment)

  3. Import license file:

    syside-license import --license-file "<path/to/syside-license.lic>"

If successful, you’ll see a confirmation message. The license will be available to all Syside products (Modeler, Modeler CLI, and Automator).

Verify Installation

After importing the license, verify your installation:

Open any .sysml file - you should see syntax highlighting and validation.

Run the following command in terminal:

syside --version

You should see output similar to: 0.8.1 (4bb41581f62d5fe422a57c1c381aa42cb41203b3)

Run the following command in terminal with Automator virtual environment activated:

python -c "import syside; print(syside.__version__)"

If successful, the Syside version will be displayed: x.x.x

Update Syside Tools

To update Syside tools in offline environments, repeat the download and installation process with the latest version.

  1. Download the latest .vsix file (see Download Files section above)

  2. Transfer to the target computer

  3. Follow the Install Tools > Modeler instructions above

Your settings and license will be preserved.

  1. Download the latest CLI archive (see Download Files section above)

  2. Transfer to the target computer

  3. Follow the Install Tools > Modeler CLI instructions above

Your license will be preserved.

  1. Download the latest .whl files (see Download Files section above)

  2. Transfer to the target computer

  3. Activate your virtual environment and update:

    pip install syside --upgrade --find-links "<path/to/wheels/directory>"

Update License

Licenses only need to be renewed when the syside-license version changes or your license expires:

  1. Generate a new license file (see Generate License File section above)

  2. Transfer the new syside-license.lic file to the target computer

  3. Import using the Import License instructions above

What’s Next?

After successfully installing Syside tools offline, continue to learn more:

Syside Modeler:
Syside Automator:
Need help?