ironbar/docs/modules/Script.md
Jake Stanger 8c75bc46ac
refactor(script): rename path to cmd for consistency
BREAKING CHANGE: This changes the option in the `script` module. Any uses of the module must be updated to use the new option name.
2022-11-28 22:25:14 +00:00

1.9 KiB

Executes a script and shows the result of stdout on a label. Pango markup is supported.

Configuration

Type: script

Name Type Default Description
cmd string null Path to the script on disk
mode 'poll' or 'watch' poll See #modes
interval number 5000 Number of milliseconds to wait between executing script

Modes

  • Use poll to run the script wait for it to exit. On exit, the label is updated to show everything the script wrote to stdout.
  • Use watch to start a long-running script. Every time the script writes to stdout, the label is updated to show the latest line. Note this does not work for all programs as they may use block-buffering instead of line-buffering when they detect output being piped.
JSON
{
  "end": [
    {
      "type": "script",
      "cmd": "/home/jake/.local/bin/phone-battery",
      "mode": "poll",
      "interval": 5000
    }
  ]
}

TOML
[[end]]
type = "script"
cmd = "/home/jake/.local/bin/phone-battery"
mode = "poll"
interval = 5000
YAML
end:
  - type: "script"
    cmd: "/home/jake/.local/bin/phone-battery"
    mode: 'poll'
    interval : 5000
Corn
{
  end = [
    {
      type = "script"
      cmd = "/home/jake/.local/bin/phone-battery"
      mode = "poll"
      interval = 5000
    }
  ]
}

Styling

Selector Description
#script Script widget label