Help & Documentation
Everything you need to know to create, edit, and share SysML v1 diagrams in SysML Studio.
Getting started
SysML Studio runs entirely in your browser — no installation, no plugins. To begin:
- Visit app.sysml.pro and click Sign In (top right).
- Create an account with email + password, or continue as a guest (guest diagrams are saved only in your browser).
- Once signed in, click + New Diagram and pick one of the nine diagram types.
- Pick a tool from the palette next to the canvas and click on the canvas to place an element; pick a relationship tool and click the source, then the target, to connect two elements.
Your work autosaves every 4 seconds once you're signed in. A green
Saved ✓ indicator appears in the header after each save.
Diagram types
SysML Studio supports the nine diagram kinds defined in OMG SysML v1.7:
BDD — Block Definition
Structural decomposition: parts, attributes, inheritance.
PKG — Package
Namespace organization and module boundaries.
REQ — Requirements
Requirements (id + text), containment, deriveReqt, satisfy, verify, refine and trace; blocks and test cases.
IBD — Internal Block
Parts, ports, connections, and item flows.
STM — State Machine
States, transitions, entry/exit actions, and triggers.
UC — Use Case
Actors, use cases, include/extend relationships.
SEQ — Sequence
Lifelines, messages, and interaction ordering.
ACT — Activity
Actions, control flow, decisions/merges, forks/joins, partitions and guards.
PAR — Parametric
Constraint properties with their equation, parameters and binding connectors.
Editing basics
Adding elements
Pick an element tool in the palette next to the canvas and click where it should go. Double-click any element (or relationship) to rename it inline; the Properties panel on the right edits everything else.
Drawing relationships
Pick a relationship tool (composition, generalization, etc.) then click the source block, then the target block. Lines are always orthogonal — you can grab and drag any middle segment to reroute.
The model behind the diagrams (XMI)
SysML v1 is a graphical language with no official text notation; its standard exchange format is XMI. Click XMI on the canvas toolbar to see the model generated from your diagrams (read-only, UML 2.5.1 + SysML 1.6). A block that appears on several diagrams is one model element.
Validation
The Validation tab lists issues such as unnamed elements, requirements that nothing satisfies or verifies, state machines without an initial state, or decision branches without a guard.
Undo / redo
Every mutation is undoable. The history stack holds up to 50 steps per diagram. See keyboard shortcuts below.
Collaboration
Real-time multi-user editing is available on the Pro plan. To invite collaborators:
- Open the diagram you want to share.
- Click the Share button in the header — a share link is generated.
- Send the link to your collaborator.
When someone joins, you'll see their presence indicator in the header and their cursor on the canvas. When a user selects an element, it's temporarily locked for other users — you'll see a colored border and the editor's name.
Collaboration uses Supabase Realtime with WebSocket broadcast. Your diagrams never leave the Supabase infrastructure.
Export & save
From the Export menu in the header you can download:
- SVG — vector graphic, best for print and web
- PNG — raster image with the current canvas theme
- PDF — printable format via browser print engine
- .xmi — the whole project as OMG XMI 2.5.1 (UML 2.5.1 + SysML 1.6), for tools that import XMI such as Cameo / MagicDraw, Papyrus or Enterprise Architect. Diagram layout is not included.
Cloud saves happen automatically every 4 seconds. You can also trigger a manual save with Ctrl + S.
Keyboard shortcuts
| Action | Shortcut |
|---|---|
| Save | Ctrl + S |
| Undo | Ctrl + Z |
| Redo | Ctrl + Shift + Z |
| Delete selected | Del or Backspace |
| Zoom in / out | Ctrl + + / Ctrl + - |
| Fit to screen | F |
| Select tool | V |
| Pan canvas | Click + drag empty area |
| Rename element | Double-click |
Note: on macOS, use ⌘ in place of Ctrl.
Privacy & your account
SysML Studio is designed with privacy-first principles. A few key points:
- Your diagrams belong to you. We don't train AI on them, we don't sell them, and we don't share them with third parties.
- Full data export is available from your user menu — one click downloads a ZIP with all your diagrams in JSON and SysML v2 formats.
- Account deletion is also one click. We delete all your data from live storage immediately; backups are purged within 30 days.
- Two-factor authentication (TOTP) is available from your user menu. We recommend enabling it.
For the full legal details, see our Privacy Policy and Cookie Policy.
Get support
Three ways to reach us:
- In-app feedback — click the 💬 button at the bottom right of the workspace to file a bug or feature request
- GitHub issues — github.com/pisystemscl/sysml-app/issues
- Email — support@sysml.pro for general questions, or security@sysml.pro for vulnerability reports
For the current system status, see the status page. For what changed recently, see the changelog.