Install Editor

Syside Editor installs from the VS Code Marketplace or the Open-VSX Marketplace, and there is no license key to enter: it is free. You need Visual Studio Code or a compatible editor already installed. See Minimum requirements for everything it needs. If you already have Syside Modeler, you have everything Editor offers and can skip this page.

Install extension

  1. Open your editor

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

  3. In the search bar, type Syside Editor

  4. Click Install on Syside Editor by Sensmetry (identifier sensmetry.syside-editor)

Where your editor cannot reach the marketplaces, or you need a specific build, install the extension from a downloaded .vsix file. The extension still downloads the Syside language server the first time you open a .sysml file, so the machine needs an internet connection once.

  1. Download the Syside Editor extension for your platform from the Open-VSX Marketplace

  1. Open your editor

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

  3. Drag and drop the sensmetry.syside-editor-*.vsix file onto the Extensions view

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

License

Editor gets its free license automatically. Licensing covers how it is validated, and What data we collect lists what is sent and what you can turn off.

Verify installation

Check that Editor 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.

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

Update Editor

Updating keeps 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 Editor 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

  • Windows 10 or newer, 64-bit (for older versions, install Windows UCRT)

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

  • Internet connection, to download the language server on first use and to check the free license

  • macOS 11.0 or newer on Apple silicon, or macOS 10.13 or newer on Intel

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

  • Internet connection, to download the language server on first use and to check the free license

  • 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, to download the language server on first use and to check the free license