Skip to main content
Version: dev-latest

MetriCal Command: Plex List

Usage​

Plex List - CLI Example
metrical plex list <WHAT_TO_LIST> [PLEX_OR_RESULTS_PATH]

Purpose​

metrical plex list prints a summary of all elements of a given kind in the Plex. This is a quick way to audit what components, constraints, or formations are present without inspecting the raw JSON.

For detailed information about a specific element, use metrical plex get.

Examples​

List all components in a Plex​

metrical plex list components input.json

List all spatial constraints​

metrical plex list spatial-constraints input.json

List formations via stdin​

cat input.json | metrical plex list formations

Arguments​

WHAT_TO_LIST​

What to list from the Plex. Possible values:

  • components: Lists all sensor components.
  • spatial-constraints (alias: spatial): Lists all spatial constraints (extrinsic relationships).
  • temporal-constraints (alias: temporal): Lists all temporal constraints (clock synchronization relationships).
  • formations: Lists all formations (named groups of components).

[PLEX_OR_RESULTS_PATH]​

The path to the input Plex. If omitted, MetriCal will read the Plex from stdin.

Options​

Global Arguments​

As with every command, all global arguments are supported (though not all may be used).