2023-06-29 16:13:15 +01:00
|
|
|
Ironvars are runtime variables that can be referenced in several places in your config,
|
|
|
|
|
then set using the IPC server (such as via the CLI) using the `set` command.
|
|
|
|
|
|
2024-01-25 22:30:53 +00:00
|
|
|
Keys can consist of alphanumeric characters, `-` and `_` only.
|
2023-06-29 16:13:15 +01:00
|
|
|
Any UTF-8 string is a valid value.
|
|
|
|
|
|
|
|
|
|
Reference values using `#my_variable`. These update as soon as the value changes.
|
|
|
|
|
|
2025-02-23 16:12:02 +00:00
|
|
|
You can set defaults using the `ironvar_defaults` key in your top-level config.
|
|
|
|
|
|
|
|
|
|
Some modules (such as `sys_info`) expose their values over the Ironvar interface,
|
|
|
|
|
allowing you to build custom interfaces and integrate into scripts.
|
|
|
|
|
These present their values inside read-only namespaces.
|
|
|
|
|
|
|
|
|
|
Some examples below:
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
ironbar var list
|
|
|
|
|
ironbar var list sysinfo
|
|
|
|
|
ironbar var list sysinfo.disk_percent
|
|
|
|
|
ironbar var get sysinfo.disk_percent./home
|
|
|
|
|
ironbar var get sysinfo.disk_percent.mean
|
|
|
|
|
ironbar var get sysinfo.memory_percent
|
|
|
|
|
```
|
