Syside Editor

Essential and performant SysML v2 language support in VS Code

Syside Editor is a free and powerful SysML v2 textual editing and analysis tool, providing essential and performant functionality to work with SysML v2 and KerML languages.

Getting Started

1. Install Syside Editor from the VS Code marketplace
2. Open any SysML v2 file (.sysml) and the extension will activate
3. Explore features in the Editor documentation

Got questions, concerns or ideas? Talk to us directly at our Community Forum. Or reach out to syside.support@sensmetry.com.

Syside Ecosystem

Syside Editor vs. Modeler

Syside Editor delivers basic language support without the visualization functionality, while Syside Modeler provides additional features, including visualization functionality, and premium support.

Important: Some functionality overlaps between Editor and Modeler. When upgrading to Modeler, uninstall the Editor to avoid conflicts.

Upgrade to Syside Modeler →

Additional Syside Tools

• Syside Automator - Python library providing a powerful SysML v2 processing engine for model generation analysis, and automation
• Sysand - Open-source package manager for SysML v2 ecosystem. Create, share, and use SysML v2 libraries & projects

Community & Support

• Community Forum - Connect with fellow systems engineers, share ideas, and get expert guidance
• Documentation - Comprehensive guide on Editor and other Syside tools
• Roadmap - See what's coming next
• Website - Learn more about Syside

Learn more: syside.sensmetry.com

Configuration

You can customize Syside Editor to fit your workflow by utilising configuration options. Refer to the Syside Editor documentation for a full list of settings available in the extension.

Configuring VS Code

Override the path to the Syside executable.

Note: This extension does not bundle the Syside executable, but instead downloads it automatically, if this setting is not set.

{
  "syside.path": "/path/to/syside"
}

Override the path to the standard library:

{
  "syside.stdlib": "/path/to/sysml.library"
}

Control the internal log level:

{
  "syside.logLevel": "trace"
}

Override the path to the log file:

{
  "syside.log": "/path/to/syside.log"
}

Include additional files and directories as external libraries:

{
  "syside.include": ["/path/to/external/lib", "/another/path/**/*.sysml"]
}

Supports glob patterns. Note that Syside does not include files and directories starting with . character (hidden files on Unix) by default, they must be provided explicitly.

Exclude files and directories from analysis:

{
  "syside.exclude": ["build/**", "temp/**", "*.tmp"]
}

Supports glob patterns.

Configure line length for automatic formatting:

{
  "syside.lineLength": 100
}

Available commands

Syside Editor provides the following commands through the Command Palette:

• Syside: Restart Language Server - Restarts the language server without the need to restart the whole Visual Studio Code window.
• Syside: Show log file - Opens the log file containing Syside logs for troubleshooting

Troubleshooting

Having issues with Syside Editor? Here's how to get help:

Problems installing or activating:

• Check your internet connection. Syside Editor does not bundle the language server executable, but rather downloads it on first activation (unless the syside.path setting is set).
• Check whether the syside.path setting is empty or correct. Syside Editor does not check whether the set path is correct. If the extension does not activate, consider resetting the syside.path setting and allowing Editor to download a new executable automatically.

Note for Windows users: archive extraction uses tar.exe which is provided by Windows 10+ since 2018-07. If this fails for any reason, download and extract binaries manually, and set syside.path configuration option to the extracted syside.exe.

For general problems:

• Check the Syside output panel for error messages
• Use the Syside: Show log file command to access logs
• Review our troubleshooting guide for common solutions

If Syside crashes:

• Check the Syside output panel for crash details
• Use the Syside: Show log file command to access logs
• Additionally, Developer Tools (Help > Toggle Developer Tools > Console) may contain additional error information that can be useful to us
• Include log files when reporting issues to our support team

Need more help? Reach out to us at syside.support@sensmetry.com or visit our Community Forum.

Developed by Sensmetry - Enabling Systems Integrated Digital Engineering to build superior systems much faster.