clients.md

description	OpenSysML client libraries — the Go, Python, Node, Java, Rust, Julia and MATLAB APIs that talk to the same runtime behind sysml, sysml-lsp and sysml-grpc.

Client libraries

The same runtime drives sysml, sysml-lsp and sysml-grpc. The clients below talk to that runtime — most through the sysml-grpc service, so a client gets exactly what the CLI gets, over the wire. See client selection to compare the libraries and service transports for what the service serves.

Published · go install

Go

The native client — the runtime's own language, so every type is the real one. go install github.com/Open-MBEE/OpenSysML/cmd/sysml@latest, or import client/opensysml.

Go packages · Go walkthrough

Published · PyPI

Python

pip install opensysml — the package downloads and verifies the matching sysml-grpc binary itself, so nothing else needs installing. Generated typed classes, signed releases.

Python client · Python API · PyPI

Published · npm

Node / TypeScript

npm install @openmbee/opensysml installs the client and its per-platform sysml-grpc binary package.

Node client · Node API · npm

Build from a checkout

Java

Not on Maven Central; build and install the Java client from a checkout.

Java client · Java API

Published · crates.io

Rust

opensysml = "0.9" installs the client from crates.io.

Rust client · Rust API · crates.io

Build from source

Julia

Not in Julia General; develop the package from a checkout.

Julia client · Julia API

Source package

MATLAB

Add the source package to the MATLAB or Octave path.

MATLAB client · MATLAB API

LSP

Editors

sysml-lsp speaks plain Language Server Protocol — VS Code has a prebuilt extension, and the same server works in any LSP-aware editor.

Editors · LSP extensions