http://wtfutil.com/ Recent content on WTF Hugo -- gohugo.io en-us Wed, 09 May 2018 14:20:48 -0700 http://wtfutil.com/posts/modules/git/ Wed, 09 May 2018 14:20:48 -0700 http://wtfutil.com/posts/modules/git/ Description Displays information about local git repositories: branch, changed files, and recent commits. Branch Displays the of the currently-active git branch. Changed Files Displays a list of all the files that have changed since the last commit, and their status. Recent Commits Displays a list of n recent commits, who committed it, and when. Source Code wtf/git/ Required ENV Variables None. Keyboard Commands Key: / Action: Open/close the widget’s help window. http://wtfutil.com/posts/modules/weather/ Wed, 09 May 2018 11:44:13 -0700 http://wtfutil.com/posts/modules/weather/ Description Displays a configurable list of current weather report, including current temperature, sunrise time, and sunset time. Source Code wtf/weather/ Required ENV Variables Key: WTF_OWM_API_KEY Action: Your OpenWeatherMap API key. Keyboard Commands Key: / Action: Open/close the widget’s help window. Key: h Action: Show the previous weather location. Key: l Action: Show the next weather location. Key: ← Action: Show the previous weather location. Key: → Action: Show the next weather location. http://wtfutil.com/posts/modules/textfile/ Wed, 09 May 2018 11:13:11 -0700 http://wtfutil.com/posts/modules/textfile/ Description Displays the contents of the specified text file in the widget. Source Code wtf/textfile/ Required ENV Variables None. Keyboard Commands Key: / Action: Open/close the widget’s help window. Key: o Action: Opens the text file in whichever text editor is associated with that file type. Configuration textfile: enabled: true filename: "notes.md" position: top: 5 left: 4 height: 2 width: 1 refreshInterval: 15 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. http://wtfutil.com/posts/modules/newrelic/ Wed, 09 May 2018 09:01:14 -0700 http://wtfutil.com/posts/modules/newrelic/ Description Connects to the New Relic API and displays the last n deploys of the monitored application: deploy ID, deploy time, and who deployed it. Source Code wtf/newrelic/ Required ENV Variables Key: WTF_NEW_RELIC_API_KEY Value: Your New Relic API token. Keyboard Commands None. Configuration newrelic: applicationId: 10549735 deployCount: 6 enabled: true position: top: 4 left: 3 height: 1 width: 2 refreshInterval: 900 Attributes applicationId The integer ID of the New Relic application you wish to report on. http://wtfutil.com/posts/modules/opsgenie/ Tue, 08 May 2018 20:53:40 -0700 http://wtfutil.com/posts/modules/opsgenie/ Description Connects to the OpsGenie API and displays all your scheduled rotations and who’s currently on call. Source Code wtf/opsgenie/ Required ENV Variables Key: WTF_OPS_GENIE_API_KEY Value: Your OpsGenie API token. Keyboard Commands None. Configuration opsgenie: enabled: true position: top: 2 left: 1 height: 2 width: 1 refreshInterval: 21600 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false. http://wtfutil.com/posts/modules/security/ Tue, 08 May 2018 20:33:28 -0700 http://wtfutil.com/posts/modules/security/ Description Displays some general information about the state of the machine’s wifi connection, firewall, and DNS settings. Wifi Network The name of the current network Whether or not the network uses encryption and if so, what flavour Firewall Whether or not the firewall is enabled Whether or not Stealth Mode is enabled DNS Which DNS resolvers (servers) the machine is configured to use Source Code wtf/security Required ENV Variables None. http://wtfutil.com/posts/modules/bamboohr/ Mon, 07 May 2018 20:17:37 -0700 http://wtfutil.com/posts/modules/bamboohr/ Description Connects to the BambooHR API and displays who will be Away today. Source Code wtf/bamboohr Required ENV Variables Key: WTF_BAMBOO_HR_TOKEN Value: Your BambooHR API token. Key: WTF_BAMBOO_HR_SUBDOMAIN Value: Your BambooHR API subdomain name. Keyboard Commands None. Configuration bamboohr: enabled: true position: top: 0 left: 1 height: 2 width: 1 refreshInterval: 900 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. http://wtfutil.com/posts/modules/clocks/ Mon, 07 May 2018 19:47:31 -0700 http://wtfutil.com/posts/modules/clocks/ Description Displays a configurable list of world clocks, the local time, and date. Source Code wtf/clocks/ Required ENV Variables None. Keyboard Commands None. Configuration clocks: colors: rows: even: "lightblue" odd: "white" enabled: true locations: # From https://en.wikipedia.org/wiki/List_of_tz_database_time_zones Avignon: "Europe/Paris" Barcelona: "Europe/Madrid" Dubai: "Asia/Dubai" UTC: "Etc/UTC" Vancouver: "America/Vancouver" Toronto: "America/Toronto" position: top: 4 left: 0 height: 1 width: 1 refreshInterval: 15 # Valid options are: alphabetical, chronological sort: "alphabetical" Attributes colors. http://wtfutil.com/posts/modules/ Mon, 07 May 2018 18:04:58 -0700 http://wtfutil.com/posts/modules/ The heart of WTF is the modules. A module is a discreet unit of functionality that extracts data from some source and packages that data for display. For example, the New Relic module uses New Relic’s API to retrieve a list of the latest deploys and packages that information as a list for display in the “New Relic” widget. The Clocks module takes a list of timezones and packages that information as a list of city/time pairs for display in the “Clocks” widget. http://wtfutil.com/posts/glossary/ Tue, 17 Apr 2018 12:34:51 -0700 http://wtfutil.com/posts/glossary/ Module A discreet unit of data collection and display. A data interface concept. A package inside the app. Examples: New Relic, Git, Weather. Widget The onscreen representation of a Module. The widget is responsible for being the interface between the app and the data collection. Widgets are defined by a required widget.go file in a Module. http://wtfutil.com/posts/configuration/ Sun, 15 Apr 2018 21:17:16 -0700 http://wtfutil.com/posts/configuration/ Configuration Files By default WTF looks in a ~/.wtf/ directory for a YAML file called config.yml. If the ~/.wtf/ directory doesn’t exist, WTF will create that directory on start-up, and then display instructions for creating a new configuration file. In other words, WTF expects to have a YAML config file at: ~/.wtf/config.yml. Example Configuration Files A couple of example config files are provided in the _sample_configs/ directory of the Git repository.