All commands

The syside command ships with the Python library and installs with it, so there is nothing separate to download. New to it? Your first CLI example walks one through checking, diagrams and a CSV export in one sitting.

Command

Description

check

Validate models for semantic errors and warnings

viz

Generate diagrams from SysML v2 models

grid

Generate CSV exports of grid views

format

Format SysML v2 models according to a consistent style

rule

Look up Syside validation rules

project

Work with SysML v2 or KerML projects

version

Display the installed version

help

Print help for a command

Optional commands

These ship as extras rather than with the default install, so each needs its extra installed before it will run:

Command

Install with

Description

reqif Labs

syside[reqif]

Import and export ReqIF exchange documents

solver Labs

syside[solver]

Check assertions and explore attainable values across a model

Settings shared with the Syside VS Code Extension live in one syside.toml: see Configure the extension for how it is discovered, and diagram settings for the [viz] table these commands read.