Read the chapters in order the first time through; each one builds on the ones before it.
- Install — a release build, Homebrew, or from source
- Your first model — declare, instantiate, evaluate
- From the command line — checking a file, exit status, scripting
- The REPL — the session model and the meta-commands
- Expressions, calculations, constraints and requirements — what a model asserts, and how to check it
- Behavior: actions and state machines — running and debugging behavior
- Saving, and converting to RDF —
%save,-convert, round trips - Editors —
sysml-lspand the VS Code extension - From your own program — the Go, Python, Node, Java and Rust clients
- Troubleshooting — diagnosing a run that stops early
Chapter 9 does one task in all five clients side by side — Go, Python, Node/TypeScript, Java and Rust, in tabs — and then has a section per client for what only that one has. Client libraries explains which to choose and what each covers.
If you want to look up a specific detail rather than read through, the reference covers the CLI flags, the REPL commands, the environment variables, the service API, the client libraries, each client's API and the RDF mapping.