System Bridge

CLI

The System Bridge CLI provides commands to interact with the System Bridge backend. All CLI commands are accessed through the system-bridge client subcommand.

Token

To get the API token for use in the API/WebSocket, run the following command:

system-bridge client token

Notification

To send a notification, use the following command:

system-bridge client notification --title "Title" --message "Message" --icon "icon-name"

Available flags:

  • --title: The title of the notification (default: “System Bridge”)
  • --message: The message of the notification (default: “Hello, world!”)
  • --icon: The icon of the notification (default: “system-bridge”)

Discovery

List Services

To list discovered services on the network, run:

system-bridge client discovery list

This will scan for available System Bridge instances and display them with their hostname, IP, port, and type.

Data

List Modules

To list all available data modules, run:

system-bridge client data list

By default, this outputs as a simple list. You can also use:

system-bridge client data list --json

To output as a JSON array.

Run Modules

To run a specific data module and get its data as JSON, use:

system-bridge client data run --module cpu

For example, to get CPU data:

system-bridge client data run --module cpu

To run all modules and get a JSON object with all data:

system-bridge client data run --all

To pretty-print the JSON output:

system-bridge client data run --module cpu --pretty

Available flags:

  • --module or -m: Module name (e.g., cpu, memory)
  • --all: Run all modules
  • --pretty: Pretty-print JSON output

Version

To get the version of System Bridge, run:

system-bridge version