CLI

The CLI (command-line interface) can be used to interact with the RTI and Inhumate Suite applications via command-line for testing and scripting purposes.

Installing

Download the package (Windows, MacOS or Linux). The install process is similar to that of the RTI.

Once installed, you’ve got an rti command to play with in your favorite command-line shell.

Quick Start

TODO to describe something useful. In the meantime, here’s the output of rti help:

Usage: rti [command] [options]

Options:
  -r|--rti <url>        URL of RTI to connect to
  -f|--federation <id>  Federation ID
  -v|--version          Show version
  -u|--user             User
  -p|--password         Password
  -s|--secret           Secret
  -C|--no-color         Don't use any color
  -?|-h|--help          Show help information

Commands:
  channels              List channels
  clients               List clients
  cmd                   Execute a command
  end                   End simulation or playback
  entity                Manipulate entity
  error                 Publish an error
  federations           List federations
  geometry              Manipulate geometry
  inject                Inject situations into scenario
  launch                Launch processes
  license               Show license information
  load                  Load scenario
  log                   Manipulate current log
  measurements          Get measurements from current log
  measures              List measures
  messages              Get messages from current log
  mocksim               Run a mock simulator
  monitor               Listen and printout messages
  participant           List participants or register participant
  passwd                Change user password
  pause                 Pause simulation or playback
  play                  Start playback
  publish               Publish something
  remote                Remote control
  reset                 Reset simulation or playback
  scale                 Set time scale
  scenario              Get current scenario
  scenarios             List scenarios
  seek                  Seek playback to scenario time
  shutdown              Shutdown processes
  start                 Start simulation
  status                Get current clients, channels, log
  stop                  Stop simulation or playback
  subscribe             Subscribe to one or more channels
  wait                  Wait for client state update

Usage Examples

TODO