1
0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00
wtf/_site/content/posts/modules/cmdrunner.md
2018-06-04 21:04:45 -07:00

1.0 KiB

title, date, draft
title date draft
CmdRunner 2018-05-17T17:17:10-07:00 false

Runs a terminal command on a schedule.

Source Code

wtf/cmdrunner/

Required ENV Variables

None.

Keyboard Commands

None.

Configuration

cmdrunner:
  args: ["-g", "batt"]
  cmd: "pmset"
  enabled: true
  position:
    top: 6
    left: 1
    height: 1
    width: 3
  refreshInterval: 30

Attributes

args
The arguments to the command, with each item as an element in an array. Example: for curl -I cisco.com, the arguments array would be ["-I", "cisco.com"].

cmd
The terminal command to be run, withouth the arguments. Ie: ping, whoami, curl.

enabled
Determines whether or not this module is executed and if its data displayed onscreen.
Values: true, false.

position
Defines where in the grid this module's widget will be displayed.

refreshInterval
How often, in seconds, this module will update its data.
Values: A positive integer, 0..n.