You can use a built version of the cli in the _up_\dist\systembridgecli
or use the python package.
Token
To get the token
for use in the API/WebSocket, you can use the following command:
python -m systembridgecli token
To reset your token
, run this command:
python -m systembridgecli token --reset
API Port
You can get the API port by running the following command:
python -m systembridgecli api-port
Data
You can retrieve the data from the data modules by running the following command:
python -m systembridgecli data MODULE
For example, to get the data from the cpu
module, run the following command:
python -m systembridgecli data cpu
This outputs the data as a table. This is good for getting current data at a glance.
Data Value
To get a single data value, run the following command:
python -m systembridgecli data-value MODULE VALUE
For example, to get the usage
value from the cpu
module, run the following command:
python -m systembridgecli data-value cpu usage
Logs
To open the logs in the default text editor, run the following command:
python -m systembridgecli open-logs
To open the backend logs in the default text editor, run the following command:
python -m systembridgecli open-logs-backend
To get the path for the logs, run the following command:
python -m systembridgecli logs-path
To get the path for the backend logs, run the following command:
python -m systembridgecli logs-path-backend
Settings
To get all settings, run the following command:
python -m systembridgecli settings
This returns all settings in a table.
Get a setting
To get a single setting, run the following command:
python -m systembridgecli setting KEY