Help & documentation

Getting started

Sysand Index is the official package registry for SysML v2 projects. Use the sysand CLI to install, publish, and manage systems engineering packages.

Installing sysand

To get started, install the sysand CLI. Once installed, you can search for and install packages directly from the command line.

Installing a package

Use sysand add <publisher>/<project> to add a package to your project. You can specify a version constraint, for example sysand add sensmetry/sysml-stdlib ^1.0. Version constraints follow the same syntax as Rust's Cargo package manager.

Publishing a package

To publish a package, create a .project.json file in your project root with the required publisher, name, and version fields. Then use sysand publish to upload your package to the index. You can also set up trusted publishers for automated publishing from CI/CD pipelines.

Frequently asked questions

Click Register in the top navigation bar and fill in your details. You will receive a verification email to confirm your account. Once verified, you can log in, create or join projects, and publish packages.

Go to Projects from the user menu to see all projects you are a member of. Project owners and maintainers can manage members, create API tokens, configure trusted publishers, and adjust project settings from the project management pages.

Organizations let teams manage projects under a shared namespace. Organization owners can invite members, assign roles (owner or manager), and transfer projects into the organization. To create an organization, go to Organizations and submit a request.

Navigate to your project's management page and go to the Members tab. As an owner, you can invite users by username, assign them a role, and set an expiration for the invitation (1-30 days). The invited user will see the invitation on their Invitations page.

API tokens allow you to authenticate with the sysand CLI and publish packages without entering your password. You can create account-level tokens (for all your projects) or project-specific tokens. Tokens have an expiration date and can be revoked at any time. Go to Account settings > Tokens or a project's Tokens tab to manage them.

Trusted publishers allow CI/CD systems (like GitHub Actions or GitLab CI) to publish packages without storing long-lived API tokens. Instead, your CI provider authenticates using OpenID Connect (OIDC). Configure trusted publishers from the Publishing tab on your project's management page.

User guide

  • Search: Use the search bar to find packages by name, publisher, or tag.
  • Install: Copy the install command from any project page and run it in your terminal.
  • Publish: Use sysand publish with an API token or trusted publisher.
  • Manage teams: Invite members, assign roles, and control access from project or organization settings.
  • Version constraints: Specify dependency versions using Cargo-style syntax (e.g., ^1.0, ~1.2, >=1.0, <2.0).
Need more help? Report bugs and ask questions on the Sysand forum.