SysModeler — User Manual
SysML v2 projects are code-first: you write model source in .sysml files, and SysModeler generates and continuously synchronizes the diagram from your text.
The built-in editor is tailored to SysML v2 textual syntax and backed by a Language Server Protocol (LSP) engine.
| Capability | Description |
|---|---|
| LSP intelligence | Real-time syntax checking, contextual auto-completion, hover definitions, and structured symbol navigation across all files |
| Code Minimap | A scaled overview on the right of the editor; click/drag to jump to sections, locate syntax errors, or find highlighted search results without manual scrolling |
| Copy code | Copy the current editor script to your system clipboard |
| Download Code | Save the code file directly to your local machine |
Compile (Ctrl + S) | Executes compilation to test syntax and render the graphical view |
When your code changes, it recompiles and the graphical view regenerates. A compilation status indicator reports progress through its lifecycle — started → in progress → completed / failed — along with the current phase (e.g., parsing, name resolution). On failure, errors point you to what to fix.
| Action | Description | Shortcut |
|---|---|---|
| Go to Definition | Jump to where the selected element/variable is declared | F12 |
| Go to References | List every place a symbol is used across the project | Shift + F12 |
| Peek Definition | Preview a definition/reference inline without leaving your location | Alt + F12 (Linux: Ctrl + Shift + F10) |
| Rename Symbol | Safely rename a symbol across the entire project | F2 |
| Change All Occurrences | Multi-caret edit of all matching instances in the active document | Ctrl + F2 |
| Format Document | Auto-clean indentation, spacing, and syntax alignment | Shift + Alt + F (Linux: Ctrl + Shift + I) |
| Toggle line comment | Comment/uncomment the current line(s) | Ctrl + / |
| Command Palette | Keyboard-first access to all editor actions | F1 (or Ctrl + Shift + P) |
As your code compiles, the graphical canvas re-renders your model automatically — the rigor of text with the readability of a diagram, without hand-drawing anything.
Right-click a node on the v2 canvas for context actions:
| Action | Description | Shortcut |
|---|---|---|
| Go to Source Code | Jump to the exact line in the editor where the node is defined | — |
| Add Reference to Chat | Insert the node into the AI Agent context to ask about it | — |
| Hide / Show Node | Temporarily remove a node from the canvas without deleting its code definition | Ctrl + Shift + H |
| Delete Node | Permanently remove the component from the model | Del |
| Custom coloring | Assign a custom node color | — |
| Expand / Collapse children | Fold or unfold a node's child elements | Ctrl + Shift + C |
Caution: In v2,
Ctrl + Shift + Hhides the selected node. In v1 the same chord aligns middle. Some references also document a plainShift + Hfor hiding; the in-app Key Bindings dialog is authoritative for your build.
| Action | Shortcut |
|---|---|
| Open file search | Ctrl + P |
| Close active tab | Alt + W |
| Zoom in | Ctrl + + |
| Zoom out | Ctrl + - |
| Horizontal scroll | Shift + Scroll |
| Reset zoom & center | Ctrl + 0 |
| Fullscreen canvas | Ctrl + Shift + F |
| Magnifier | Alt + Hover |
The v2 diagram also provides Dynamic Collision Avoidance, the Canvas Minimap, Search Node, and ELK Auto-Layout, exactly as on the v1 canvas (Section 9.3, 9.8).