Migrate to Syside v1

These guides move a project written for an older Syside to Syside v1, whether you work in the VS Code Extension or with the Python library.

Before you start:

  1. Back up or commit the project.

  2. While Syside v0.11 is still installed, make the exports that Check the result compares against. Diagram exports can’t be made afterwards. Table exports can, in compatibility mode, as that page says.

  3. Install Syside v1: the Python library and CLI as in Install the Python Library & CLI, the VS Code Extension as in Install the VS Code Extension.

Then follow the guides in this order:

  1. Migrate SysML models - Fix the errors and warnings an older model reports in v1, with instructions for an LLM agent

  2. Migrate Syside settings - Move editor settings into syside.toml, rename the extension’s settings and commands, and keep the formatter’s output

  3. Migrate diagram views - Rename diagram settings, update the syside viz and syside grid commands, and review what changed in the diagrams

  4. Migrate grid views - Move table and matrix views to the 1.0 SysideViews library

  5. Migrate Python scripts - Update scripts that use the Python library

  6. Check the result - Compare the result with the Syside v0.11 exports and check ReqIF exports