Grid command

Writes the grid views a model defines out as CSV, so a table you read in the editor can also be read by whatever consumes CSV. The views themselves stay in the model, which is what keeps the export reproducible.

Export command

Export grid views defined in the SysML v2 model as CSV files. A hierarchical table exports its whole tree with a leading Level column that records each row’s depth, as described in Export to CSV.

Basic usage

Pass one or more model files or directories to export all defined grid views into the output/ directory:

syside grid export <paths...>

  • <paths...> - one or more .sysml / .kerml files, directories (searched recursively) or glob patterns

Note

This command exports grid views (table and matrix views) only. Other view definitions are handled by syside viz view. Passing a non-grid view to --qualified-name results in an error.

Available options

Option

Description

-h, --help

Display the help message with all available flags and short descriptions

-c, --config <CONFIG>

Path to a syside.toml configuration file. If not specified, the config is discovered by walking upward from the current directory, stopping at a directory that contains .git or sysand-lock.toml. Config values for include and exclude are used as fallbacks when the corresponding CLI flags are not provided

-i, --include <INCLUDE>

Additional paths to include (e.g. external libraries). These are additional root paths merged with positional arguments for file discovery.

-e, --exclude <EXCLUDE>

Paths or glob patterns to exclude from file discovery. Matching files are removed from the result.

-n, --qualified-name <QUALIFIED_NAME>

Qualified names of the views to export. Defaults to all table and matrix views in the model

-o, --output-dir <OUTPUT_DIR>

Save the CSV files to the given directory. Defaults to ./output

--bom

Prepend a Byte Order Mark (BOM) to the CSV file to ensure Microsoft Excel correctly detects the UTF-8 encoding and displays special characters properly.

--max-file-name-length <CHARACTERS>

Longest file name to write, in characters. Only the view’s own name is shortened to fit; the table-/matrix- prefix, the number that keeps two shortened names apart and .csv are always kept. Defaults to 100

Note

In SysML v2, element names can contain spaces and special characters (e.g. 'Flight Controller v2' or 'Motor "Type A"'). When passing qualified names that contain such names, make sure to quote or escape them appropriately for your shell. For example, names with spaces should be wrapped in double quotes:

syside grid export -n "MyPackage::'My Table View'" models/

Alternatively, use simple names without spaces or special characters.