Skip to content

Command Line Interface

XSMP Modeler ships with a project-oriented CLI.

The CLI works at project level, not file level. It loads the target project, scans a workspace root to discover related xsmp.project files, resolves dependencies by project name, checks the target project together with its visible dependencies, and can run the generators selected for that project.

Main commands

The CLI currently provides two commands:

  • validate <path>
  • generate <path>

<path> can be:

  • a project directory containing xsmp.project
  • or the xsmp.project file itself

Run from a GitHub release

Download the CLI artifact xsmpproject-cli-<version>.cjs from the GitHub Releases page.

The release artifact is a single JavaScript file. Run it with Node.js 22.13.0 or newer:

node xsmpproject-cli-<version>.cjs --help

node xsmpproject-cli-<version>.cjs validate path/to/project

node xsmpproject-cli-<version>.cjs generate path/to/project

Workspace root discovery

Both commands support:

--workspace-root <dir>

If you do not provide it, XSMP Modeler uses the parent directory of the target project directory.

The workspace root is scanned recursively for xsmp.project files so that dependencies declared with dependency '<project-name>' can be resolved.

Validation behavior

validate reports errors and warnings only for:

  • the target project
  • the projects reachable through its dependencies
  • the modeling documents visible from that dependency closure

Errors and warnings from unrelated projects that happen to exist in the selected workspace root do not fail the command.

If a declared dependency is missing from the selected workspace root, the CLI reports an explicit error.

Generation behavior

generate first validates the target project and its visible dependency closure.

Generation runs only if no validation errors remain in that scope. When validation succeeds, XSMP Modeler runs the generators contributed by the tools and profile declared in the target project's xsmp.project.

Dependencies do not contribute their own active tools or profiles to the target project.

Exit codes

The CLI uses these exit codes:

  • 0: success
  • 1: validation errors on the target project or its visible dependencies
  • 2: usage error, input error or startup failure

Examples

Validate a project directory:

node xsmpproject-cli-<version>.cjs validate path/to/missionsystem

Validate a project file explicitly:

node xsmpproject-cli-<version>.cjs validate path/to/missionsystem/xsmp.project

Generate with an explicit workspace root:

node xsmpproject-cli-<version>.cjs generate path/to/missionsystem --workspace-root path/to/workspace