Install the VS Code Extension

The Syside VS Code Extension installs from the VS Code Marketplace or the Open-VSX Marketplace into Visual Studio Code or a compatible editor, and its textual language features are free.

Install extension

Windows

macOS

Linux

x86-64 (Intel or AMD)

syside-win32-x64

syside-darwin-x64

syside-linux-x64

arm64 (Apple silicon, ARM)

syside-win32-arm64

syside-darwin-arm64

not built

  1. Download the VSIX by clicking on the entry matching your platform in the table above.

  1. Open your editor

  2. Click Extensions in the left sidebar (Ctrl/Cmd+Shift+X)

  3. Drag and drop the downloaded .vsix file onto the Extensions view

    Alternatively, open the Command Palette (Ctrl/Cmd+Shift+P), run Extensions: Install from VSIX…, and select the file

Verify installation

Check that the extension flags an error:

  1. In your editor, save this as example.sysml:

    package Example {
   part def Electrical;

   part Automobile {
      part Motor : Electricall;
   }
}

    You should see an error highlighted and listed in the Problems panel (Ctrl/Cmd+Shift+M):

    Error on the misspelled part definition

  2. Correct the spelling to Electrical and save

    The error should disappear.

The status bar should show Syside: Free: the language features run on the free plan, which the extension activates automatically. Licensing covers how it is validated, and What data we collect lists what is sent and what you can turn off.

Activate license

The diagram, grid view and other paid commands stay in the menus without a license, and running one shows a notification offering Activate license and See pricing. A license unlocks them in place, with no second install. The extension checks the license with our licensing servers as you work.

  1. Open the Command Palette (Ctrl/Cmd+Shift+P) and run Syside: Check Syside license

    A prompt for your Syside license key should open:

    Syside license key prompt

    Clicking Syside: Free in the status bar opens the same prompt, and so does Activate license on the notification. The extension never asks on its own.

  2. Enter your license key and press Enter

    A confirmation message should appear, and the status bar should change to Syside: Paid:

    Confirmation that the Syside license is valid

    When it fails, an error message appears instead. Check the key and try again, and if it keeps failing, see Troubleshooting.

  3. Wait for Syside Tools to install

    The paid features run on Syside Tools, which the extension downloads once the license is valid. A notification shows the progress and should end with “Syside tools installed successfully”.

    When the download fails, click Retry on the error, or open the Command Palette (Ctrl/Cmd+Shift+P) and run Syside: Install Syside Tools.

  4. Open the Command Palette (Ctrl/Cmd+Shift+P) and run Syside: Add Syside license key to keyring

    This stores the key in your operating system’s secret storage, where Python Library & CLI finds it too, so the key is entered once per machine.

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

Check that the paid features work: with example.sysml from the verification above open, click the Syside logo (top right) and select Syside: Visualize current file (Ctrl/Cmd+Shift+V). A diagram of the model should open:

Diagram of the example model

Continue to Write your model, or start at Troubleshooting if something did not work.

Update the extension

Updating keeps your license activation and your settings.

By default, your editor updates extensions automatically. Reload the extension when it prompts you after an update.

If you are not receiving automatic updates:

  1. Click Extensions in the left sidebar (Ctrl/Cmd+Shift+X)

  2. Find Syside: SysML v2 Automate Systems Engineering in the list

  3. Verify the Auto Update checkbox is enabled

A VSIX install does not update itself. Repeat the installation steps with the latest version.

Minimum requirements

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

    Check yours with ldd --version. The first line ends with the glibc version, as in ldd (Ubuntu GLIBC 2.39-0ubuntu8.8) 2.39.

  • An editor to host the extension: Visual Studio Code (recommended), Cursor, or VSCodium

  • Internet connection, or an offline license

  • A paid plan for diagrams, grid views and inlay hints