Skip to content

CLI Reference

This page is generated from the mbse-lab Click command tree. Run python3 scripts/generate_cli_reference.py --check to verify that it matches the implementation.

mbse-lab

Usage: mbse-lab [OPTIONS] COMMAND [ARGS]...

  Operate the local SysML v2 lab and private model workspaces.

Options:
  --version              Show the version and exit.
  --repo-root DIRECTORY  Path to the shared mbse lab repo. Defaults to searching from the current
                         directory.
  -h, --help             Show this message and exit.

Commands:
  bootstrap    Prepare the local lab for first use.
  bridge       Render and move snapshots between Flexo and SysON.
  cleanup      Remove generated local reports, diagnostics, run logs, and temporary output.
  completion   Print shell completion setup for Bash, Zsh, or Fish.
  deployment   Inspect or verify the container deployment contract.
  diagnostics  Collect a redacted diagnostics bundle.
  doctor       Check local prerequisites, repo layout, workspace settings, and service...
  first-model  Create a tiny Flexo model and import it into a SysON review project.
  flexo        Work with Flexo SysML v2 projects.
  init         Create local runtime env files and optional private workspace layout.
  report       Generate a static Markdown/HTML local lab report.
  services     Start, stop, restart, and inspect local lab services.
  share-check  Check for accidental private data before sharing the tooling repo.
  smoke        Run proof workflows for the local lab.
  status       Run the existing Flexo and SysON status checks.
  syson        Work with SysON projects and import namespaces.
  workspace    Create and inspect private model workspaces.

mbse-lab completion

Usage: mbse-lab completion [OPTIONS] {bash|zsh|fish}

  Print shell completion setup for Bash, Zsh, or Fish.

Options:
  -h, --help  Show this message and exit.

mbse-lab init

Usage: mbse-lab init [OPTIONS]

  Create local runtime env files and optional private workspace layout.

Options:
  --model-workspace PATH          Initialize a private model workspace and print the export command.
  --force-workspace               Overwrite generated workspace README.md and .gitignore files.
  --workspace-git / --no-workspace-git
                                  Initialize git in --model-workspace when needed.
  --dry-run                       Print the planned setup without changing files.
  -h, --help                      Show this message and exit.

mbse-lab bootstrap

Usage: mbse-lab bootstrap [OPTIONS]

  Prepare the local lab for first use.

Options:
  --model-workspace PATH          Initialize a private model workspace and print the export command.
  --force-workspace               Overwrite generated workspace README.md and .gitignore files.
  --workspace-git / --no-workspace-git
                                  Initialize git in --model-workspace when needed.
  --skip-start                    Prepare files but do not start Flexo or SysON containers.
  --skip-flexo-org                Do not initialize the Flexo SysML v2 org.
  --skip-backup                   Do not back up Flexo after org initialization.
  --skip-status                   Do not run final service status checks.
  --timeout INTEGER               Container startup/status timeout in seconds.  [default: 60]
  --dry-run                       Print the planned commands without changing files or containers.
  -h, --help                      Show this message and exit.

mbse-lab first-model

Usage: mbse-lab first-model [OPTIONS] [NAME]

  Create a tiny Flexo model and import it into a SysON review project.

Options:
  --package-name TEXT        Name of the first SysML package. Defaults to NAME.
  --syson-project-name TEXT  Name of the SysON review project. Defaults to '<NAME> Review'.
  --output-dir PATH          Directory for generated export artifacts.
  --flexo-url TEXT           [default: http://localhost:18083]
  --syson-url TEXT           [default: http://localhost:18090]
  --timeout INTEGER          [default: 30]
  --json-output              Print a machine-readable JSON summary.
  --dry-run                  Print the planned workflow without creating projects.
  --allow-repo-exports       Suppress the warning when MBSE_MODEL_WORKSPACE is unset and writing to
                             repo-local exports/.
  -h, --help                 Show this message and exit.

mbse-lab smoke

Usage: mbse-lab smoke [OPTIONS] COMMAND [ARGS]...

  Run proof workflows for the local lab.

Options:
  -h, --help  Show this message and exit.

Commands:
  first-use  Validate first-use setup by creating and importing a disposable model.

mbse-lab smoke first-use

Usage: mbse-lab smoke first-use [OPTIONS] [NAME]

  Validate first-use setup by creating and importing a disposable model.

Options:
  --package-name TEXT        Name of the first SysML package. Defaults to NAME.
  --syson-project-name TEXT  Name of the SysON review project. Defaults to '<NAME> Review'.
  --output-dir PATH          Directory for generated export artifacts.
  --report-dir DIRECTORY     Directory for the generated lab report.  [default: reports/latest]
  --flexo-url TEXT           [default: http://localhost:18083]
  --syson-url TEXT           [default: http://localhost:18090]
  --timeout INTEGER          [default: 60]
  --json-output              Print a machine-readable JSON summary.
  --dry-run                  Print the planned workflow without starting services or creating
                             projects.
  --allow-repo-exports       Suppress the warning when MBSE_MODEL_WORKSPACE is unset and writing to
                             repo-local exports/.
  -h, --help                 Show this message and exit.

mbse-lab doctor

Usage: mbse-lab doctor [OPTIONS]

  Check local prerequisites, repo layout, workspace settings, and service reachability.

Options:
  --json-output  Print a machine-readable JSON report.
  --fix          Apply low-risk local setup fixes and print remaining next commands.
  -h, --help     Show this message and exit.

mbse-lab status

Usage: mbse-lab status [OPTIONS]

  Run the existing Flexo and SysON status checks.

Options:
  --json-output  Print a machine-readable JSON report.
  -h, --help     Show this message and exit.

mbse-lab services

Usage: mbse-lab services [OPTIONS] COMMAND [ARGS]...

  Start, stop, restart, and inspect local lab services.

Options:
  -h, --help  Show this message and exit.

Commands:
  down     Stop Flexo and SysON services without deleting runtime data.
  logs     Show recent Flexo and SysON service logs.
  restart  Restart Flexo and SysON services.
  up       Start Flexo and SysON services.

mbse-lab services up

Usage: mbse-lab services up [OPTIONS]

  Start Flexo and SysON services.

Options:
  --flexo / --no-flexo  Start Flexo services.
  --syson / --no-syson  Start SysON services.
  --wait / --no-wait    Wait for selected service APIs during startup.
  --timeout INTEGER     Startup readiness timeout in seconds.  [default: 60]
  --dry-run             Print commands without changing containers.
  -h, --help            Show this message and exit.

mbse-lab services down

Usage: mbse-lab services down [OPTIONS]

  Stop Flexo and SysON services without deleting runtime data.

Options:
  --flexo / --no-flexo  Stop Flexo services.
  --syson / --no-syson  Stop SysON services.
  --volumes             Also remove Flexo compose-managed volumes.
  --dry-run             Print commands without changing containers.
  -h, --help            Show this message and exit.

mbse-lab services restart

Usage: mbse-lab services restart [OPTIONS]

  Restart Flexo and SysON services.

Options:
  --flexo / --no-flexo  Restart Flexo services.
  --syson / --no-syson  Restart SysON services.
  --wait / --no-wait    Wait for Flexo health during startup.
  --timeout INTEGER     Flexo startup wait timeout in seconds.  [default: 60]
  --dry-run             Print commands without changing containers.
  -h, --help            Show this message and exit.

mbse-lab services logs

Usage: mbse-lab services logs [OPTIONS]

  Show recent Flexo and SysON service logs.

Options:
  --flexo / --no-flexo  Show Flexo logs.
  --syson / --no-syson  Show SysON app logs.
  --flexo-service TEXT  Flexo compose service to include.
  --syson-service TEXT  SysON compose service to include.
  -f, --follow          Follow logs.
  --tail INTEGER        Number of log lines to show.  [default: 100]
  --dry-run             Print commands without reading logs.
  -h, --help            Show this message and exit.

mbse-lab diagnostics

Usage: mbse-lab diagnostics [OPTIONS]

  Collect a redacted diagnostics bundle.

Options:
  --public-safe       Omit project lists and recent service logs from the diagnostics bundle.
  --output PATH       Diagnostics bundle output directory.
  --timeout INTEGER   Command and HTTP timeout in seconds.  [default: 20]
  --log-tail INTEGER  Number of service log lines to collect.  [default: 80]
  -h, --help          Show this message and exit.

mbse-lab report

Usage: mbse-lab report [OPTIONS]

  Generate a static Markdown/HTML local lab report.

Options:
  --output-dir DIRECTORY  Directory for generated report files.  [default: reports/latest]
  -h, --help              Show this message and exit.

mbse-lab cleanup

Usage: mbse-lab cleanup [OPTIONS]

  Remove generated local reports, diagnostics, run logs, and temporary output.

Options:
  --include-site  Also remove MkDocs build output under site/.
  --dry-run       Print cleanup targets without removing files.
  -h, --help      Show this message and exit.

mbse-lab share-check

Usage: mbse-lab share-check [OPTIONS]

  Check for accidental private data before sharing the tooling repo.

Options:
  -h, --help  Show this message and exit.

mbse-lab flexo

Usage: mbse-lab flexo [OPTIONS] COMMAND [ARGS]...

  Work with Flexo SysML v2 projects.

Options:
  -h, --help  Show this message and exit.

Commands:
  backup          Export the live Flexo Fuseki dataset to a durable backup.
  create          Create a Flexo SysML v2 project.
  export          Export a Flexo project snapshot.
  init-org        Create the Flexo org used by the SysML v2 service.
  list            List Flexo SysML v2 projects.
  restore         Restore Flexo mount/cluster.nq from a backup file.
  rotate-secrets  Regenerate ignored local Flexo runtime secrets.
  token           Request a local Flexo JWT from the auth service.

mbse-lab flexo init-org

Usage: mbse-lab flexo init-org [OPTIONS]

  Create the Flexo org used by the SysML v2 service.

Options:
  --layer1-url TEXT  [default: http://localhost:18080]
  --env-dir PATH     [default: deploy/flexo-mms]
  --org-id TEXT      [default: sysmlv2]
  --title TEXT       [default: SysML v2]
  --token TEXT
  --timeout INTEGER  [default: 30]
  --dry-run
  -h, --help         Show this message and exit.

mbse-lab flexo token

Usage: mbse-lab flexo token [OPTIONS]

  Request a local Flexo JWT from the auth service.

Options:
  --url TEXT         Auth service login URL. Defaults to the generated auth host port.
  --username TEXT    [default: user01]
  --password TEXT    LDAP password. Defaults to FLEXO_MMS_LDAP_USER01_PASSWORD in .env.
  --timeout INTEGER  [default: 30]
  --dry-run
  -h, --help         Show this message and exit.

mbse-lab flexo backup

Usage: mbse-lab flexo backup [OPTIONS]

  Export the live Flexo Fuseki dataset to a durable backup.

Options:
  --url TEXT                      Fuseki dataset URL. Defaults to the generated Fuseki host port.
  --output PATH                   Backup file path.
  --timeout INTEGER               [default: 60]
  --update-init / --no-update-init
                                  Also refresh tracked mount/cluster.nq after export.
  --i-understand-this-updates-tracked-seed
                                  Required with --update-init to acknowledge that tracked seed data
                                  must be publishable.
  --dry-run
  -h, --help                      Show this message and exit.

mbse-lab flexo restore

Usage: mbse-lab flexo restore [OPTIONS] BACKUP

  Restore Flexo mount/cluster.nq from a backup file.

Options:
  --dry-run
  -h, --help  Show this message and exit.

mbse-lab flexo rotate-secrets

Usage: mbse-lab flexo rotate-secrets [OPTIONS]

  Regenerate ignored local Flexo runtime secrets.

Options:
  --dry-run
  -h, --help  Show this message and exit.

mbse-lab flexo list

Usage: mbse-lab flexo list [OPTIONS]

  List Flexo SysML v2 projects.

Options:
  --json-output      Print raw JSON from Flexo.
  --flexo-url TEXT   [default: http://localhost:18083]
  --timeout INTEGER  [default: 30]
  --dry-run
  -h, --help         Show this message and exit.

mbse-lab flexo create

Usage: mbse-lab flexo create [OPTIONS] NAME

  Create a Flexo SysML v2 project.

Options:
  --description TEXT
  --flexo-url TEXT    [default: http://localhost:18083]
  --timeout INTEGER   [default: 30]
  --dry-run
  -h, --help          Show this message and exit.

mbse-lab flexo export

Usage: mbse-lab flexo export [OPTIONS] PROJECT_ID

  Export a Flexo project snapshot.

Options:
  --commit-id TEXT
  --output PATH
  --flexo-url TEXT      [default: http://localhost:18083]
  --timeout INTEGER     [default: 30]
  --dry-run
  --allow-repo-exports  Suppress the warning when MBSE_MODEL_WORKSPACE is unset and writing to repo-
                        local exports/.
  -h, --help            Show this message and exit.

mbse-lab syson

Usage: mbse-lab syson [OPTIONS] COMMAND [ARGS]...

  Work with SysON projects and import namespaces.

Options:
  -h, --help  Show this message and exit.

Commands:
  create  Create a SysON project.
  list    List SysON projects.
  roots   List root namespace elements for a SysON project.

mbse-lab syson list

Usage: mbse-lab syson list [OPTIONS]

  List SysON projects.

Options:
  --syson-url TEXT   [default: http://localhost:18090]
  --timeout INTEGER  [default: 30]
  --dry-run
  -h, --help         Show this message and exit.

mbse-lab syson create

Usage: mbse-lab syson create [OPTIONS] NAME

  Create a SysON project.

Options:
  --template-id TEXT  [default: sysmlv2-template]
  --library-id TEXT   SysON library ID to include. Repeatable.
  --syson-url TEXT    [default: http://localhost:18090]
  --timeout INTEGER   [default: 30]
  --dry-run
  -h, --help          Show this message and exit.

mbse-lab syson roots

Usage: mbse-lab syson roots [OPTIONS] PROJECT_ID

  List root namespace elements for a SysON project.

Options:
  --json-output      Print raw JSON roots.
  --syson-url TEXT   [default: http://localhost:18090]
  --timeout INTEGER  [default: 30]
  --dry-run
  -h, --help         Show this message and exit.

mbse-lab bridge

Usage: mbse-lab bridge [OPTIONS] COMMAND [ARGS]...

  Render and move snapshots between Flexo and SysON.

Options:
  -h, --help  Show this message and exit.

Commands:
  import  Import a .sysml file into a SysON namespace.
  render  Render a Flexo export JSON file as SysML textual notation.
  run     Export from Flexo, render SysML text, and import into SysON.

mbse-lab bridge render

Usage: mbse-lab bridge render [OPTIONS] INPUT

  Render a Flexo export JSON file as SysML textual notation.

Options:
  --output PATH
  --report              Write render-report.json next to the SysML output.
  --report-output PATH  Write render coverage report to this path.
  --dry-run
  --allow-repo-exports  Suppress the warning when MBSE_MODEL_WORKSPACE is unset and writing to repo-
                        local exports/.
  -h, --help            Show this message and exit.

mbse-lab bridge import

Usage: mbse-lab bridge import [OPTIONS] INPUT

  Import a .sysml file into a SysON namespace.

Options:
  --project-id TEXT          [required]
  --namespace-id TEXT        [required]
  --editing-context-id TEXT
  --syson-url TEXT           [default: http://localhost:18090]
  --timeout INTEGER          [default: 30]
  --dry-run
  -h, --help                 Show this message and exit.

mbse-lab bridge run

Usage: mbse-lab bridge run [OPTIONS] FLEXO_PROJECT_ID

  Export from Flexo, render SysML text, and import into SysON.

Options:
  --commit-id TEXT
  --syson-project-id TEXT
  --namespace-id TEXT
  --create-syson-project TEXT  Create a SysON review project and import into its root package.
  --editing-context-id TEXT
  --output-dir PATH
  --run-log PATH
  --run-log-dir PATH
  --flexo-url TEXT             [default: http://localhost:18083]
  --syson-url TEXT             [default: http://localhost:18090]
  --timeout INTEGER            [default: 30]
  --json-output                Print a machine-readable JSON summary.
  --dry-run
  --allow-repo-exports         Suppress the warning when MBSE_MODEL_WORKSPACE is unset and writing
                               to repo-local exports/.
  -h, --help                   Show this message and exit.

mbse-lab workspace

Usage: mbse-lab workspace [OPTIONS] COMMAND [ARGS]...

  Create and inspect private model workspaces.

Options:
  -h, --help  Show this message and exit.

Commands:
  check  Check a private model workspace layout.
  env    Print the shell command for setting MBSE_MODEL_WORKSPACE.
  init   Initialize a private model workspace.

mbse-lab workspace init

Usage: mbse-lab workspace init [OPTIONS] PATH

  Initialize a private model workspace.

Options:
  --force           Overwrite generated README.md and .gitignore files.
  --git / --no-git  Initialize a git repository if one is not present.
  -h, --help        Show this message and exit.

mbse-lab workspace check

Usage: mbse-lab workspace check [OPTIONS] [PATH]

  Check a private model workspace layout.

Options:
  -h, --help  Show this message and exit.

mbse-lab workspace env

Usage: mbse-lab workspace env [OPTIONS] [PATH]

  Print the shell command for setting MBSE_MODEL_WORKSPACE.

Options:
  -h, --help  Show this message and exit.

mbse-lab deployment

Usage: mbse-lab deployment [OPTIONS] COMMAND [ARGS]...

  Inspect or verify the container deployment contract.

Options:
  -h, --help  Show this message and exit.

Commands:
  contract        Print the fixture-derived deployment runtime contract.
  isolated-smoke  Start and verify a disposable isolated deployment.
  verify          Verify Docker runtime state against the deployment contract.

mbse-lab deployment contract

Usage: mbse-lab deployment contract [OPTIONS]

  Print the fixture-derived deployment runtime contract.

Options:
  --fixture PATH  Deployment fixture path.
  --json-output   Print a machine-readable JSON contract.
  -h, --help      Show this message and exit.

mbse-lab deployment verify

Usage: mbse-lab deployment verify [OPTIONS]

  Verify Docker runtime state against the deployment contract.

Options:
  --fixture PATH       Deployment fixture path.
  --project-name TEXT  Inspect containers by Compose project and service labels instead of fixed
                       container names.
  --timeout INTEGER    [default: 20]
  --json-output        Print a machine-readable JSON report.
  --output PATH        Write the structured verification report as JSON.
  -h, --help           Show this message and exit.

mbse-lab deployment isolated-smoke

Usage: mbse-lab deployment isolated-smoke [OPTIONS]

  Start and verify a disposable isolated deployment.

Options:
  --fixture PATH           Deployment fixture path.
  --project-name TEXT      Compose project name. Defaults to a generated unique name.
  --runtime-dir DIRECTORY  Directory for disposable bind-mounted data. Defaults under tmp/isolated-
                           deployments/.
  --timeout INTEGER        [default: 120]
  --output PATH            Write the structured verification report as JSON.
  --keep                   Leave the isolated deployment running after verification.
  --dry-run                Print commands without starting containers.
  -h, --help               Show this message and exit.