CLI command reference

This is the complete command catalogue of the sysml CLI (sysml 0.1.0), captured from the binary’s own --help output — nothing here is hand-maintained. For task-oriented walkthroughs, start at CLI workflows instead.

Global usage

Usage: sysml [OPTIONS] <COMMAND>

Global option	Description
--quiet	Suppress progress output on stderr (also silences the progress subscriber even when stderr is a TTY). Place before the subcommand

Command	Summary
sysml init	Initialize a new SysML project
sysml info	Show project information
sysml add	Add a dependency to sysml.toml
sysml remove	Remove a dependency from sysml.toml
sysml lock	Resolve dependencies and update sysml.lock
sysml fetch	Resolve dependencies and fetch/cache all sources (without writing sysml.lock)
sysml update	Force dependency update and rewrite sysml.lock
sysml tree	Show dependency graph
sysml why	Show why a dependency exists in the resolved graph
sysml cache	Manage local dependency cache
sysml package	Build a .kpar distribution archive
sysml eval	Evaluate a SysML expression
sysml check	Check constraints in a SysML file
sysml verify	Run a verification case
sysml analysis	Run an analysis case
sysml trade-study	Run a trade study (evaluate alternatives against an objective)
sysml simulate	Simulate a state machine
sysml run	Run an action
sysml solve	Solve constraint network via binding propagation
sysml trace	Generate a sequence trace from flow simulation
sysml flow	Inspect and test port flows
sysml project	Manage SysML projects (legacy)
sysml query	Query elements in a SysML model
sysml export	Export a SysML model to various formats
sysml inspect	Inspect semantic tokens and diagnostics for a SysML file

sysml init

Initialize a new SysML project

Usage: sysml init [OPTIONS]

Option	Description
--name <NAME>	Project name (creates a new directory)

sysml info

Show project information

Usage: sysml info [OPTIONS]

Option	Description
--manifest-path <MANIFEST_PATH>	Path to sysml.toml (auto-discovered if omitted)
--json	Output as JSON

sysml add

Add a dependency to sysml.toml

Usage: sysml add [OPTIONS] <NAME>

Argument	Description
<NAME>	Dependency name

Option	Description
--path <PATH>	Local path dependency
--git <GIT>	Git repository URL
--tag <TAG>	Git tag
--branch <BRANCH>	Git branch
--rev <REV>	Git revision (commit hash)
--kpar <KPAR>	KPAR archive URL

sysml remove

Remove a dependency from sysml.toml

Usage: sysml remove <NAME>

Argument	Description
<NAME>	Dependency name to remove

sysml lock

Resolve dependencies and update sysml.lock

Usage: sysml lock [OPTIONS]

Option	Description
--force	Force re-resolve even if lock file is up to date
--quiet	Suppress non-error output
--json	Output as JSON

sysml fetch

Resolve dependencies and fetch/cache all sources (without writing sysml.lock)

Usage: sysml fetch [OPTIONS]

Option	Description
--quiet	Suppress non-error output
--json	Output as JSON

sysml update

Force dependency update and rewrite sysml.lock

Usage: sysml update [OPTIONS]

Option	Description
--quiet	Suppress non-error output
--json	Output as JSON

sysml tree

Show dependency graph

Usage: sysml tree [OPTIONS]

Option	Description
--quiet	Suppress non-error output
--json	Output as JSON

sysml why

Show why a dependency exists in the resolved graph

Usage: sysml why [OPTIONS] <NAME>

Argument	Description
<NAME>	Dependency package name

Option	Description
--quiet	Suppress non-error output
--json	Output as JSON

sysml cache

Manage local dependency cache

Usage: sysml cache <COMMAND>

sysml cache clean

Remove cached dependency artifacts

Usage: sysml cache clean [OPTIONS]

Option	Description
--all	Also remove other cache files under the cache root
--json	Output as JSON
--quiet	Suppress non-error output

sysml package

Build a .kpar distribution archive

Usage: sysml package [OPTIONS]

Option	Description
--manifest-path <MANIFEST_PATH>	Path to sysml.toml (auto-discovered if omitted)
-o, --output <OUTPUT>	Output directory (default: target/package/)

sysml eval

Evaluate a SysML expression

Usage: sysml eval <EXPR>

Argument	Description
<EXPR>	The expression to evaluate (e.g. “2 + 3”)

sysml check

Check constraints in a SysML file

Usage: sysml check [OPTIONS] <FILE>

Argument	Description
<FILE>	Path to the SysML file

Option	Description
--set <OVERRIDES>	Override attribute values (e.g. –set mass=2600)
--json	Output results as JSON

sysml verify

Run a verification case

Usage: sysml verify [OPTIONS] <CASE_NAME> <FILE>

Argument	Description
<CASE_NAME>	Name of the verification case to run
<FILE>	Path to the SysML file

Option	Description
--set <OVERRIDES>	Override attribute values (e.g. –set speed=85)
--json	Output results as JSON

sysml analysis

Run an analysis case

Usage: sysml analysis [OPTIONS] <CASE_NAME> <FILE>

Argument	Description
<CASE_NAME>	Name of the analysis case to run
<FILE>	Path to the SysML file

Option	Description
--set <OVERRIDES>	Override attribute values (e.g. –set temperature=350)
--json	Output results as JSON

sysml trade-study

Run a trade study (evaluate alternatives against an objective)

Usage: sysml trade-study [OPTIONS] <STUDY_NAME> <FILE>

Argument	Description
<STUDY_NAME>	Name of the trade study analysis case
<FILE>	Path to the SysML file

Option	Description
--set <OVERRIDES>	Override attribute values (e.g. –set mass=100)
--json	Output results as JSON

sysml simulate

Simulate a state machine

Usage: sysml simulate [OPTIONS] <SM_NAME> <FILE>

Argument	Description
<SM_NAME>	Name of the state machine
<FILE>	Path to the SysML file

Option	Description
--events <EVENTS>	Comma-separated list of events (e.g. “timer,timer,reset”)
--interactive	Interactive mode: read events from stdin
--auto	Auto-demo mode: walk all transitions automatically
--trace	Show detailed execution trace
--json	Output results as JSON

sysml run

Run an action

Usage: sysml run [OPTIONS] <ACTION_NAME> <FILE>

Argument	Description
<ACTION_NAME>	Name of the action to run
<FILE>	Path to the SysML file

Option	Description
--trace	Show detailed execution trace
--json	Output results as JSON

sysml solve

Solve constraint network via binding propagation

Usage: sysml solve [OPTIONS] <FILE>

Argument	Description
<FILE>	Path to the SysML file

Option	Description
--set <OVERRIDES>	Override attribute values (e.g. –set mass=2600)
--rollup <ROLLUP>	Compute rollup for a named property (e.g. –rollup mass)
--sweep <SWEEP>	Sweep a parameter across a range (format: param:lo:hi, e.g. –sweep speed:0:200)
--json	Output results as JSON

sysml trace

Generate a sequence trace from flow simulation

Usage: sysml trace [OPTIONS] <FILE>

Argument	Description
<FILE>	Path to the SysML file

Option	Description
--inject <INJECT>	Inject messages to simulate flow (format: source.port:value, repeatable)
--json	Output results as JSON

sysml flow

Inspect and test port flows

Usage: sysml flow [OPTIONS] <FILE>

Argument	Description
<FILE>	Path to the SysML file

Option	Description
--flow-name <FLOW_NAME>	Name of a specific flow (optional — shows all if omitted)
--inject <INJECT>	Inject a payload into the flow source (JSON or simple value)
--json	Output results as JSON

sysml project

Manage SysML projects (legacy)

Usage: sysml project <COMMAND>

sysml project init

Initialize a new SysML project in the current directory

Usage: sysml project init [OPTIONS]

Option	Description
--name <NAME>	Project name (defaults to the current directory name)
--version <VERSION>	Project version (defaults to “0.1.0”) [default: 0.1.0]

sysml project info

Show project information

Usage: sysml project info

sysml project stdlib

List standard library projects

Usage: sysml project stdlib [OPTIONS]

Option	Description
--symbols	List all symbols exported by each library

sysml query

Query elements in a SysML model

Usage: sysml query <COMMAND>

sysml query find

Find elements by name pattern

Usage: sysml query find [OPTIONS] --name <NAME> <FILE>

Argument	Description
<FILE>	Path to the SysML file

Option	Description
--name <NAME>	Name pattern to search for (substring match)
--kind <KIND>	Filter by element kind (e.g. PartUsage, RequirementUsage)
--json	Output as JSON

sysml query stats

Show element statistics

Usage: sysml query stats [OPTIONS] <FILE>

Argument	Description
<FILE>	Path to the SysML file

Option	Description
--json	Output as JSON

sysml query trace

Show traceability matrix (requirements to parts via Satisfy)

Usage: sysml query trace [OPTIONS] <FILE>

Argument	Description
<FILE>	Path to the SysML file

Option	Description
--json	Output as JSON

sysml query unverified

Show unverified requirements

Usage: sysml query unverified [OPTIONS] <FILE>

Argument	Description
<FILE>	Path to the SysML file

Option	Description
--json	Output as JSON

sysml export

Export a SysML model to various formats

Usage: sysml export <COMMAND>

sysml export plantuml

Export model as PlantUML diagram

Usage: sysml export plantuml [OPTIONS] <FILE>

Argument	Description
<FILE>	Path to the SysML file

Option	Description
--view <VIEW>	Diagram view type [default: general] [possible values: general, state, action, sequence]

sysml export json

Export model as canonical JSON

Usage: sysml export json [OPTIONS] <FILE>

Argument	Description
<FILE>	Path to the SysML file

Option	Description
--pretty	Pretty-print the JSON output

sysml export viewmodel

Export a declared view’s ViewModel JSON (scene + tokens + text-map + interactions + frame / non-graph payload), sidecars pruned to the view’s referenced ids

Usage: sysml export viewmodel [OPTIONS] --workspace <WORKSPACE> --view <VIEW>

Option	Description
--workspace <WORKSPACE>	Workspace directory to load (declared views render against the whole workspace)
--view <VIEW>	Qualified name of the declared view to export (e.g. ShowcaseViews::OverviewView; a unique bare name also resolves)
--expand-all	Expand every expandable node
--expand <EXPAND>	Element id to render expanded (repeatable)
-o, --output <OUTPUT>	Write the JSON to this file instead of stdout

sysml inspect

Inspect semantic tokens and diagnostics for a SysML file

Usage: sysml inspect [OPTIONS] [FILE]

Argument	Description
[FILE]	Path to the SysML file (required unless –workspace is used)

Option	Description
--tokens	Show only semantic tokens
--diagnostics	Show only diagnostics
--cst	Show raw CST (tree-sitter parse tree)
--json	Output as JSON
--no-stdlib	Disable loading the standard library for inspect diagnostics
--library-path <LIBRARY_PATH>	Override standard library path (directory containing library.kernel/library.systems)
--workspace <WORKSPACE>	Inspect all files in a workspace directory with cross-file resolution
--focus <FOCUS>	Focus diagnostics on a specific file within workspace mode
--no-workspace-deps	Disable dependency source hydration in workspace mode

How this page is generated

This page and its data artifact were generated by node scripts/generate-reference.mjs (run from website/) at sysml-rs commit 11bd751 on 2026-08-25. Input: sysml 0.1.0 at target/release/sysml; the full raw help text per command is stored in the artifact. Do not edit the page by hand — regenerate it. npm run gen-check reports drift between the committed artifacts and a fresh generation.