First steps#

Now that you have installed Sysand, this page helps you take a first look around. The sysand command behaves the same on Windows, macOS, and Linux, so the examples in this documentation apply regardless of your operating system.

Check that Sysand works#

Run this in a terminal and check that it prints a version number:

$ sysand --version

If the command is not found, return to verify the installation for troubleshooting.

The commands you will use most#

A few commands cover most day-to-day work:

  • sysand init creates a new Sysand project: a directory of model files plus metadata that sysand manages for you.

  • sysand include adds a model file to your project.

  • sysand add adds a dependency (called a “usage” in the KerML and SysML v2 specifications) to your project.

  • sysand sources lists the model files of your project and its dependencies.

  • sysand build packages your project into a KPAR archive for sharing: a KerML Project Archive, a single file containing the whole project.

  • sysand publish uploads a package to a Sysand index: a service that hosts packages, such as the official Sysand Index.

You do not need to memorize these now. The tutorial linked below introduces most of them one at a time, in the order you would naturally reach for them, and publishing has a tutorial of its own.

Getting help#

Every command describes itself. Add --help after any command to see what it does and which options it accepts:

$ sysand init --help

The commands reference covers the same information in browsable form, with a page per command.

Next steps#

Follow Creating your first project to go from an empty directory to a packaged project with managed dependencies.

When you are ready to share a project publicly, Publishing your first project in the Sysand Index docs shows how.