Install the VS Code Extension

The Syside VS Code Extension installs into Visual Studio Code or a compatible editor from a .vsix file, which you download here with your license key. The file carries everything the extension needs, so it makes no further downloads once installed.

Install extension

  1. Enter your license key and download the Syside VS Code Extension for the machine that will run it (the download may take a few seconds to start)

  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

Activate license

The extension runs with a license, so enter the key you downloaded it with. It 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

  2. Enter your license key and press Enter

    A confirmation message should appear:

    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. 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.

Licensing covers how the license is validated, and What data we collect lists what is sent and what you can turn off.

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.

Then check that the diagrams work: with example.sysml 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

The extension does not update itself. To update, repeat the installation steps with the latest version. Updating keeps your license activation and your settings.

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