VS Code Extension
Syside comes as a VS Code extension, installed from a .vsix file
downloaded with your license key. It works the
same in VS Code compatible editors such as Cursor, Kiro,
VSCodium and others.
VS Code Extension: generates configurable visualizations, creates editable tables from your models, adds a tab for saved model views and more.
Syside uses the same engine here and in Python, so a model that checks out in one checks out in the other.
Get started
Install the VS Code Extension – Start here
Then take whichever first run matches your work:
Write your model – Your first textual modeling example
Visualize your model – Visualize your model
Build a table view – Build a table from your model, column by column
Build a matrix view – Build a requirement traceability matrix, and add a derivation from it
Then get to know the UIs:
Diagram views UI – What a diagram panel offers once it is open
Table views UI – The views panel, editing cells, exporting to CSV
Matrix views UI – The matrix toolbar, cell marks and context menu
How-to guides
Configure diagram views – Choose the diagram kind a view produces and set its depth, layout and output
Build a hierarchical table view – Show a system breakdown or requirement hierarchy as a collapsible tree
Add frequently used table columns – Copy-ready columns for IDs, values, documentation, constraints and more
Make a matrix editable – Set up a matrix view so that it can add and remove relationships
Migrate grid views – Move views written for Syside 0.11 to the 1.0 notation
Explanation
Table view concepts – How columns and cells work, how rows fan out, how a hierarchical table builds its tree, and what an edit writes
Table navigation chains – How a navigation chain gets from one element to another
Matrix view concepts – How a matrix finds its rows, columns and cells, and what an editable one writes
Reference
Diagram settings – Every
[viz]option, with its type and defaultSelect view elements –
exposeandfilter, the two statements that decide which elements a view shows, and the include flags grid views addTable view structure – What a table view definition contains
Navigation step reference – Every navigation step, with its arguments
Cell representations – How a cell renders, and which ones can be edited
Complete table view examples – Complete, working table views, each with a small model, to copy from
Matrix view structure – What a matrix view definition contains: axes, cell view, direction and attributes
Configure the extension – Where settings live, how config files are discovered and merged, and what takes priority
Settings in syside.toml – Reference for every
syside.tomloptionSettings in the editor – Reference for the
syside.*settings the extension adds
Troubleshooting
Troubleshoot grid views – What a grid view reports when it cannot show what you asked for