Skip to content

trust-runtime

trust-runtime is the main operator, developer, and automation CLI for truST.

Top-level trust-runtime --help

Figure: The top-level trust-runtime command families exactly as the shipped binary reports them.

Top-level Command Families

Command Purpose
run / play start a runtime instance
ui interactive terminal UI
ctl send control requests to a running runtime
build generate program.stbc
validate validate project config + bundle
test run ST tests
docs generate API docs from tagged ST comments
hmi scaffold/update/reset hmi/
plcopen PLCopen import/export/profile
registry package registry workflows
setup initialize system I/O config
ide serve the browser IDE
agent serve the external agent contract
wizard create a new project folder
deploy / rollback versioned deployment and rollback
bench communication/runtime benchmark surfaces
conformance deterministic conformance suite runner

Common Commands

Build

Usage: trust-runtime build [OPTIONS]

Primary options:

  • --project
  • --sources
  • --ci

Validate

Usage: trust-runtime validate [OPTIONS] --project <PROJECT>

Primary options:

  • --project
  • --ci

Test

Usage: trust-runtime test [OPTIONS]

Primary options:

  • --project
  • --filter
  • --list
  • --timeout
  • --output
  • --ci

Agent

Usage: trust-runtime agent [OPTIONS] <COMMAND>

Current stable subcommand:

  • serve

HMI

Usage: trust-runtime hmi [OPTIONS] <COMMAND>

Current subcommands:

  • init
  • update
  • reset

PLCopen

Usage: trust-runtime plcopen [OPTIONS] <COMMAND>

Current subcommands:

  • profile
  • export
  • import

Control

Usage: trust-runtime ctl [OPTIONS] <COMMAND>

Important control subcommands:

  • status
  • health
  • stats
  • io-read
  • io-write
  • io-force
  • io-unforce
  • restart
  • shutdown
  • config-get
  • config-set

trust-runtime ctl --help

Figure: The ctl command family and its subcommands. Use this when you need the scriptable control API.

Common Flows

Build / validate / test

trust-runtime build --project ./my-plc --sources src
trust-runtime validate --project ./my-plc
trust-runtime test --project ./my-plc --output json

Start runtime

trust-runtime play --project ./my-plc

Run agent API

trust-runtime agent serve --project ./my-plc

trust-runtime agent serve --help

Figure: The agent serve entrypoint and its current stable flags. This is the CLI contract agents and wrappers should target first.

Serve browser IDE

trust-runtime ide serve --project ./my-plc --listen 127.0.0.1:18080