mirror of
https://github.com/taigrr/wtf
synced 2025-01-18 04:03:14 -08:00
295 lines
51 KiB
JSON
295 lines
51 KiB
JSON
[
|
|
{
|
|
"uri": "/posts/modules/twitter/",
|
|
"title": "Twitter",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Added in v0.1.2.\nConnects to the Twitter API and displays a single user\u0026rsquo;s tweets.\nNOTE: This only works for single-application developer accounts for now.\nSource Code wtf/twitter/ Keyboard Commands None.\nConfiguration twitter: bearerToken: \u0026#34;3276d7155dd9ee27b8b14f8743a408a9\u0026#34; enabled: true position: top: 0 left: 1 height: 1 width: 1 refreshInterval: 20000 Attributes bearerToken Value: Your Twitter single-application Bearer Token\nenabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: Any positive integer, 0..n.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/zendesk/",
|
|
"title": "Zendesk",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Added in v0.1.0.\nDisplays tickets in the \u0026ldquo;New\u0026rdquo; status - i.e. have not yet been assigned.\nSource Code wtf/zendesk/ Keyboard Commands Key: [return] Action: Open the selected ticket in the browser.\nKey: j Action: Select the next item in the list.\nKey: k Action: Select the previous item in the list.\nKey: ↓ Action: Scroll down the list.\nKey: ↑ Action: Scroll up the list.\nConfiguration zendesk: apiKey: \u0026#34;3276d7155dd9ee27b8b14f8743a408a9\u0026#34; enabled: true position: top: 0 left: 2 height: 1 width: 1 status: \u0026#34;new\u0026#34; subdomain: \u0026#34;your_domain\u0026#34; username: \u0026#34;your_email@acme.com\u0026#34; Attributes apiKey Value: Your Zendesk API token.\nenabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. status The status of tickets you want to retrieve. Values: new, open, pending, hold.\nsubdomain Value: Your Zendesk subdomain.\nusername Your Zendesk username Values: A valid Zendesk username (usually an email address).\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/travisci/",
|
|
"title": "TravisCI",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Added in v0.0.12.\nDisplays build information for your Travis CI account.\nSource Code wtf/travisci/ Keyboard Commands None.\nConfiguration travisci: apiKey: \u0026#34;3276d7155dd9ee27b8b14f8743a408a9\u0026#34; enabled: true position: top: 4 left: 1 height: 1 width: 2 pro: false refreshInterval: 900 Attributes apiKey Value: Your Travis CI API access token.\nenabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\npro Determines whether or not this module will use the Pro version of Travis CI.\nValues: true, false.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/todoist/",
|
|
"title": "Todoist",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Added in v0.0.11.\nDisplays all items on specified project.\nSource Code wtf/todoist/ Keyboard Commands Key: h Action: Show the previous project.\nKey: ← Action: Show the previous project.\nKey: l Action: Show the next project.\nKey: → Action: Show the next project.\nKey: j Action: Select the next item in the list.\nKey: ↓ Action: Select the next item in the list.\nKey: k Action: Select the previous item in the list.\nKey: ↑ Action: Select the previous item in the list.\nKey: c Action: Close current item.\nKey: d Action: Delete current item.\nKey: r Action: Reload all projects.\nConfiguration todoist: apiKey: \u0026#34;3276d7155dd9ee27b8b14f8743a408a9\u0026#34; enabled: true position: top: 0 left: 2 height: 1 width: 1 projects: - 122247497 refreshInterval: 3600 Attributes apiKey Value: Your Todoist API token.\nenabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nposition Where in the grid this module\u0026rsquo;s widget will be displayed. projects The todoist projects to fetch items from. Values: The integer ID of the project.\nrefreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/gerrit/",
|
|
"title": "Gerrit",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Displays information about your projects hosted on Gerrit:\nOpen Incoming Reviews All open reviews that are requesting your approval.\nMy Outgoing Reviews All open reviews created by you.\nSource Code wtf/gerrit/ Keyboard Commands Key: / Action: Open/close the widget\u0026rsquo;s help window.\nKey: h Action: Show the previous project.\nKey: l Action: Show the next project.\nKey: j Action: Select the next review in the list.\nKey: k Action: Select the previous review in the list.\nKey: r Action: Refresh the data.\nKey: ← Action: Show the previous project.\nKey: → Action: Show the next project.\nKey: ↓ Action: Select the next review in the list.\nKey: ↑ Action: Select the previous review in the list.\nKey: [return] Action: Open the selected review in the browser.\nConfiguration gerrit: colors: rows: even: \u0026#34;lightblue\u0026#34; odd: \u0026#34;white\u0026#34; domain: https://gerrit-review.googlesource.com enabled: true password: \u0026#34;mypassword\u0026#34; position: top: 2 left: 3 height: 2 width: 2 projects: - org/test-project\u0026#34; - dotfiles refreshInterval: 300 username: \u0026#34;myname\u0026#34; verifyServerCertificate: false Attributes colors.rows.even Define the foreground color for even-numbered rows. Values: Any X11 color name.\ncolors.rows.odd Define the foreground color for odd-numbered rows. Values: Any X11 color name.\ndomain Your Gerrit corporate domain. Values: A valid URI.\nenabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.\npassword Value: Your Gerrit HTTP Password.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. projects A list of Gerrit project names to fetch data for. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\nusername Your Gerrit username.\nverifyServerCertificate Optional Determines whether or not the server\u0026rsquo;s certificate chain and host name are verified. Values: true, false.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/logger/",
|
|
"title": "Logger",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Displays the contents of the WTF log file.\nTo log to this file in your own modules:\nrequire \u0026#34;github.com/senorprogrammer/wtf/logger\u0026#34; logger.Log(\u0026#34;This is a log entry\u0026#34;) Source Code wtf/logger/ Required ENV Variables None.\nKeyboard Commands Arrow keys scroll through the log file.\nConfiguration logger: enabled: true position: top: 5 left: 4 height: 2 width: 1 refreshInterval: 1 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Note: If you\u0026rsquo;re using logging and logging is disabled, your logs will still be written to file, the widget just won\u0026rsquo;t be shown onscreen. If you have logger.Log calls in your code, regardless of this setting, they will be written out. Values: true, false.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/cryptocurrencies/blockfolio/",
|
|
"title": "Blockfolio",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Added in v0.0.8.\nDisplay your Blockfolio crypto holdings.\nSource wtf/blockfolio/ Required ENV Variables None.\nKeyboard Commands None.\nConfiguration blockfolio: colors: name: blue grows: green drop: red device_token: \u0026#34;device token\u0026#34; displayHoldings: true enabled: true position: top: 3 left: 1 width: 1 height: 1 refreshInterval: 400 Attributes colors.name Values: Any X11 color name.\ncolors.grows Values: Any X11 color name.\ncolors.drop Values: Any X11 color name.\ndevice_token Value: See this gist for details on how to get your Blockfolio API token.\ndisplayHoldings enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/ipapi/",
|
|
"title": "IP-API",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Added in v0.0.7.\nDisplays your current IP address information, from IP-APIcom.\nNote: IP-API.com has a free-plan rate limit of 120 requests per minute.\nSource Code wtf/ipapi/ Required ENV Variables None.\nKeyboard Commands None.\nConfiguration ipinfo: colors: name: red value: white enabled: true position: top: 1 left: 2 height: 1 width: 1 refreshInterval: 150 Attributes colors.name The default colour for the row names. Values: Any X11 color name.\ncolors.value The default colour for the row values. Values: Any X11 color name.\nenabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/circleci/",
|
|
"title": "CircleCI",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Added in v0.0.7.\nDisplays build information for your CircleCI account.\nSource Code wtf/circleci/ Keyboard Commands None.\nConfiguration circleci: apiKey: \u0026#34;3276d7155dd9ee27b8b14f8743a408a9\u0026#34; enabled: true position: top: 4 left: 1 height: 1 width: 2 refreshInterval: 900 Attributes apiKey Value: Your CircleCI API token.\nenabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/gspreadsheet/",
|
|
"title": "Google Spreadsheets",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Added in v0.0.7.\nDisplay information from cells in a Google Spreadsheet.\nwtf/gspreadsheets/ Required ENV Variables None.\nKeyboard Commands None.\nConfiguration gspreadsheets: colors: values: \u0026#34;green\u0026#34; cells: names: - \u0026#34;Cell 1 name\u0026#34; - \u0026#34;Cell 2 name\u0026#34; addresses: - \u0026#34;A1\u0026#34; - \u0026#34;A2\u0026#34; enabled: true position: top: 0 left: 0 width: 1 height: 1 refreshInterval: \u0026#34;300\u0026#34; secretFile: \u0026#34;~/.config/wtf/gspreadsheets/client_secret.json\u0026#34; sheetId: \u0026#34;id_of_google_spreadsheet\u0026#34; Attributes colors.values The color to display the cell values in. Values: Any X11 color name.\ncells.names cells.addresses enabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nposition Where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\nsecretFile Your Google client secret JSON file. Values: A string representing a file path to the JSON secret file.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/jenkins/",
|
|
"title": "Modules: Jenkins",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Added in v0.0.8.\nDisplays jenkins status of given builds in a project or view\nSource Code wtf/jenkins/ Keyboard Commands None.\nConfiguration jenkins: apiKey: \u0026#34;3276d7155dd9ee27b8b14f8743a408a9\u0026#34; enabled: true position: top: 2 left: 3 height: 2 width: 3 refreshInterval: 300 url: \u0026#34;https://jenkins.domain.com/jenkins/view_url\u0026#34; user: \u0026#34;username\u0026#34; verifyServerCertificate: true Attributes apiKey Value: Your Jenkins API key.\nenabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed.\nrefreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\nuser Your Jenkins username. url The url to your Jenkins project or view. Values: A valid URI.\nverifyServerCertificate Optional Determines whether or not the server\u0026rsquo;s certificate chain and host name are verified. Values: true, false.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/gitlab/",
|
|
"title": "GitLab",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Added in v0.0.8.\nDisplays information about your projects hosted on GitLab:\nOpen Approval Requests All open merge requests that are requesting your approval.\nOpen Merge Requests All open merge requests created by you.\nSource Code wtf/gitlab/ Keyboard Commands Key: / Action: Open/close the widget\u0026rsquo;s help window.\nKey: h Action: Show the previous project.\nKey: l Action: Show the next project.\nKey: ← Action: Show the previous project.\nKey: → Action: Show the next project.\nConfiguration gitlab: apiKey: \u0026#34;3276d7155dd9ee27b8b14f8743a408a9\u0026#34; enabled: true position: top: 2 left: 3 height: 2 width: 2 refreshInterval: 300 projects: tasks: \u0026#34;gitlab-org/release\u0026#34; gitlab-ce: \u0026#34;gitlab-org\u0026#34; username: \u0026#34;senorprogrammer\u0026#34; Attributes apiKey Value: A GitLab personal access token. Requires at least api access.\nenabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\ndomain Optional. Your GitLab corporate domain. Values: A valid URI.\nprojects A list of key/value pairs each describing a GitLab project to fetch data for. Key: The name of the project. Value: The namespace of the project.\nusername Your GitLab username. Used to figure out which requests require your approval\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/cryptocurrencies/bittrex/",
|
|
"title": "Bittrex",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Added in v0.0.5.\nGet the last 24 hour summary of cryptocurrencies market using Bittrex.\nSource Code wtf/cryptoexchanges/bittrex/ Required ENV Variables None.\nKeyboard Commands None.\nConfiguration bittrex: enabled: true position: top: 1 left: 2 height: 3 width: 1 refreshInterval: 5 summary: BTC: displayName: Bitcoin market: - LTC - ETH colors: base: name: orange displayName: red market: name: red field: white value: green Attributes colors.base.name Values: Any X11 color name.\ncolors.base.dispayName Values: Any X11 color name.\ncolors.market.name Values: Any X11 color name.\ncolors.market.field Values: Any X11 color name.\ncolors.market.value Values: Any X11 color name.\nsummary enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/cryptocurrencies/cryptolive/",
|
|
"title": "CryptoLive",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Added in v0.0.5.\nCompare crypto currencies using CryptoCompare.\nSource Code wtf/cryptoexchanges/cryptolive/ Required ENV Vars None.\nKeyboard Commands None.\nConfiguration cryptolive: enabled: true position: top: 5 left: 2 height: 1 width: 2 updateInterval: 15 currencies: BTC: displayName: Bitcoin to: - USD - EUR - ETH - LTC - DOGE LTC: displayName: Ethereum to: - USD - EUR - BTC top: BTC: displayName: Bitcoin limit: 5 to: - USD colors: from: name: coral displayName: grey to: name: white price: green top: from: name: grey displayName: coral to: name: red field: white value: green Attributes colors.from.name Values: Any X11 color name.\ncolors.from.dispayName Values: Any X11 color name.\ncolors.to.name Values: Any X11 color name.\ncolors.to.price Values: Any X11 color name.\ncurrencies enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/prettyweather/",
|
|
"title": "Pretty Weather",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Displays weather information as ASCII art from Wttr.in.\nSource Code wtf/prettyweather/ Required ENV Variables None.\nKeyboard Commands None.\nConfiguration prettyweather: enabled: true city: \u0026#34;tehran\u0026#34; position: top: 3 left: 5 height: 1 width: 1 refreshInterval: 300 unit: \u0026#34;c\u0026#34; view: 0 language: \u0026#34;en\u0026#34; Attributes city Optional. It will grab the current location from your IP address if omitted.\nValues: The name of any city supported by Wttr.in.\nenabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\nunit Optional. It will use metric if you are out of US and imperial for US.\nThe temperature scale in which to display temperature values. Values: F for Fahrenheit, C for Celcius.\nview Optional Wttr.in view configuration. Values: See curl wttr.in/:help for more details.\nlanguage Optional Wttr.in language configuration. Values: See curl wttr.in/:translation for more details.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/ipinfo/",
|
|
"title": "IPInfo",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Displays your current IP address information, from ipinfo.io.\nNote: IPInfo.io has a free-plan rate limit of 1000 requests per day.\nSource Code wtf/ipinfo/ Required ENV Variables None.\nKeyboard Commands None.\nConfiguration ipinfo: colors: name: red value: white enabled: true position: top: 1 left: 2 height: 1 width: 1 refreshInterval: 150 Attributes colors.name The default colour for the row names. Values: Any X11 color name.\ncolors.value The default colour for the row values. Values: Any X11 color name.\nenabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/power/",
|
|
"title": "Power",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Displays information about the current power source.\nFor battery, also displays the current charge, estimated time remaining, and whether it is charging or discharging.\nSource Code wtf/power/ Required ENV Variables None.\nKeyboard Commands None.\nConfiguration power: enabled: true position: top: 5 left: 0 height: 2 width: 1 refreshInterval: 15 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/configuration/iterm2/",
|
|
"title": "Configuration: iTerm2",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": "Many terminal apps don\u0026rsquo;t properly display multibyte emoji characters properly. This may fix the issue for you in iTerm2, it also may not.\nBy default iTerm2 uses a unicode rendering format that is not comletely compatible with some emoji characters. Instead what you\u0026rsquo;ll see is the emoji over-lapping normal text characters, or drawing outside the bounds of where they should be.\nIn iTerm2 open:\nPreferences -\u0026gt; Profiles -\u0026gt; Text and check on the \u0026ldquo;Use Unicode Version 9 Widths\u0026rdquo; checkbox. Then restart WTF.\n(Note: This issue is not unique to iTerm2. As of this writing it also affects Terminal, and Hyper.)\n"
|
|
},
|
|
{
|
|
"uri": "/posts/overview/",
|
|
"title": "Overview",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " WTF is a personal information dashboard for your terminal, developed for those who spend most of their day in the command line.\nIt allows you to monitor services and systems that you otherwise might keep browser tabs open for, the kinds of things you don\u0026rsquo;t always need visible, but might check in on every now and then.\nQuick Start Download the stand-alone, compiled binary. Unzip the downloaded file. From the command line, cd into the newly-created /wtf directory. From the command line, run the app: ./wtf This should launch the app in your terminal using the default simple configuration. See Configuration for more details.\nCommand-line Options --config, -c Allows you to define a custom config file to use. See Configuration for more details.\n--help, -h Shows help information for the command-line arguments that WTF takes.\n--module, -m Shows help information for the specific named module, if that module supports help text. Example: wtf --module=todo.\n--version, -v Shows version info.\nKeyboard Commands Key: Ctrl-R Action: Force-refresh the data for all modules.\nKey: Esc Action: Unfocus the currently-focused widget.\nKey: Tab Action: Move between focusable modules (Shift-Tab to move backwards).\n"
|
|
},
|
|
{
|
|
"uri": "/posts/installation/",
|
|
"title": "Installation",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " There are two ways to install WTF:\nFrom Source Get this repo and install the dependencies:\ngo get -u github.com/senorprogrammer/wtf cd $GOPATH/src/github.com/senorprogrammer/wtf make install make run and that should probably do it.\nAs a Binary Grab the latest version from here:\nhttps://github.com/senorprogrammer/wtf/releases expand it, and cd into the resulting directory. Then run:\n./wtf and that should also do it.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/cmdrunner/",
|
|
"title": "CmdRunner",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Runs a terminal command on a schedule.\nSource Code wtf/cmdrunner/ Required ENV Variables None.\nKeyboard Commands None.\nConfiguration cmdrunner: args: [\u0026#34;-g\u0026#34;, \u0026#34;batt\u0026#34;] cmd: \u0026#34;pmset\u0026#34; 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 [\u0026quot;-I\u0026quot;, \u0026quot;cisco.com\u0026quot;].\ncmd 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.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed.\nrefreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/configuration/attributes/",
|
|
"title": "Configuration: Attributes",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " The following top-level attributes are configurable in config.yml. See this example config file for more details.\nwtf: colors: background: \u0026#34;red\u0026#34; border: Focusable: \u0026#34;darkslateblue\u0026#34; focused: \u0026#34;orange\u0026#34; normal: \u0026#34;gray\u0026#34; grid: # How _wide_ the columns are, in terminal characters. In this case we have # six columns, each of which are 35 characters wide columns: [35, 35, 35, 35, 35, 35] # How _high_ the rows are, in terminal lines. In this case we have five rows # that support ten line of text, one of three lines, and one of four rows: [10, 10, 10, 10, 10, 3, 4] # The app redraws itself once a second openFileUtil: open refreshInterval: 1 term: \u0026#34;xterm-256color\u0026#34; Attributes colors.background The color to draw the background of the app in. Use this to match your terminal colors. May be over-written by individual module configurations. Values: Any X11 color name.\ncolors.border.focusable The color in which to draw the border of widgets that can accept keyboard focus. Values: Any X11 color name.\ncolors.border.focused The color in which to draw the border of the widget that currently has keyboard focus. Values: Any X11 color name.\ncolors.border.normal The color in which to draw the borders of the widgets that cannot accept focus. Values: Any X11 color name.\ngrid.columns An array that defines the widths of all the columns. Values: See tview\u0026rsquo;s Grid for details.\ngrid.rows An array that defines the heights of all the rows. Values: See tview\u0026rsquo;s Grid for details.\nopenFileUtil Command to use to open a file or URL\nrefreshInterval How often, in seconds, the UI refreshes itself. Note: This implementation is probably wrong and buggy and likely to change. Values: A positive integer, 0..n.\nterm Optional. Sets a custom value for the terminal type this app runs in. Leave this entry out of the config if you simply want to use your terminal\u0026rsquo;s default setting. Note: If an invalid value is provided for this setting, the app will crash with a \u0026quot;terminal entry not found\u0026quot; error. Values: Any valid terminal type (ie: vt100, xterm, xterm-256color, ansi, etc.).\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/todo/",
|
|
"title": "Todo",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " An interactive todo list.\nSource Code wtf/todo/ Required ENV Variables None.\nKeyboard Commands Key: [return] Action: Edit the selected item. Action: Close the modal item dialog and save changes. Key: [esc] Action: Remove focus from the selected item. Action: Close the modal item dialog without saving changes.\nKey: [space] Action: Check/uncheck the selected item.\nKey: / Action: Open/close the widget\u0026rsquo;s help window.\nKey: j Action: Select the next item in the list.\nKey: k Action: Select the previous item in the list.\nKey: n Action: Create a new list item.\nKey: o Action: Opens the todo list file in whichever text editor is associated with that file type.\nKey: ↓ Action: Select the next item in the list.\nKey: ↑ Action: Select the previous item in the list.\nKey: Ctrl-d Action: Delete the selected item.\nKey: Ctrl-J Action: Move the selected item down the list.\nKey: Ctrl-K Action: Move the selected item up the list.\nConfiguration todo: checkedIcon: \u0026#34;X\u0026#34; colors: checked: gray highlight: fore: \u0026#34;black\u0026#34; back: \u0026#34;orange\u0026#34; enabled: true filename: \u0026#34;todo.yml\u0026#34; position: top: 2 left: 2 height: 2 width: 1 refreshInterval: 3600 Attributes checkedIcon The icon used to denote a \u0026ldquo;checked\u0026rdquo; todo item. Values: Any displayable unicode character.\ncolors.checked Values: Any X11 color name.\ncolors.highlight.fore The foreground color for the currently-selected row. Values: Any X11 color name.\ncolors.highlight.back The background color for the currently-selected row. Values: Any X11 color name.\nenabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nfilename The name for the todo file. Values: Any valid filename, ideally ending in yml.\nposition Where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/jira/",
|
|
"title": "Jira",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Displays all Jira issues assigned to you for the specified project.\nSource Code wtf/jira/ Keyboard Commands Key: [return] Action: Open the selected issue in the browser.\nKey: j Action: Select the next item in the list.\nKey: k Action: Select the previous item in the list.\nKey: ↓ Action: Select the next item in the list.\nKey: ↑ Action: Select the previous item in the list.\nConfiguration Single Jira Project jira: apiKey: \u0026#34;3276d7155dd9ee27b8b14f8743a408a9\u0026#34; colors: rows: even: \u0026#34;lightblue\u0026#34; odd: \u0026#34;white\u0026#34; domain: \u0026#34;https://umbrellacorp.atlassian.net\u0026#34; email: \u0026#34;chriscummer@me.com\u0026#34; enabled: true jql: \u0026#34;issueType = Story\u0026#34; position: top: 4 left: 1 height: 1 width: 2 project: \u0026#34;ProjectA\u0026#34; refreshInterval: 900 username: \u0026#34;chris.cummer\u0026#34; verifyServerCertificate: true Multiple Jira Projects If you want to monitor multiple Jira projects, use the following configuration (note the difference in project):\njira: apiKey: \u0026#34;3276d7155dd9ee27b8b14f8743a408a9\u0026#34; colors: rows: even: \u0026#34;lightblue\u0026#34; odd: \u0026#34;white\u0026#34; domain: \u0026#34;https://umbrellacorp.atlassian.net\u0026#34; email: \u0026#34;chriscummer@me.com\u0026#34; enabled: true jql: \u0026#34;issueType = Story\u0026#34; position: top: 4 left: 1 height: 1 width: 2 project: [\u0026#34;ProjectA\u0026#34;, \u0026#34;ProjectB\u0026#34;] refreshInterval: 900 username: \u0026#34;chris.cummer\u0026#34; verifyServerCertificate: true Attributes apiKey Value: Your Jira API key.\ncolors.rows.even Define the foreground color for even-numbered rows. Values: Any X11 color name.\ncolors.rows.odd Define the foreground color for odd-numbered rows. Values: Any X11 color name.\ndomain Your Jira corporate domain. Values: A valid URI.\nemail The email address associated with your Jira account. Values: A valid email address string.\nenabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.\njql Optional Custom JQL to be appended to the search query. Values: See Search Jira like a boss with JQL for details.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. project The Jira project to fetch information for. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\nusername Your Jira username. verifyServerCertificate Optional Determines whether or not the server\u0026rsquo;s certificate chain and host name are verified. Values: true, false.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/trello/",
|
|
"title": "Trello",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Displays all Trello cards on specified lists.\nSource Code wtf/trello/ Keyboard Commands None.\nConfiguration Single Trello List trello: accessToken: \u0026#34;7b8b14f8743a408a93276d7155dd9ee2\u0026#34; apiKey: \u0026#34;3276d7155dd9ee27b8b14f8743a408a9\u0026#34; board: Main enabled: true list: \u0026#34;Todo\u0026#34; position: height: 1 left: 2 top: 0 width: 1 refreshInterval: 3600 username: myname Multiple Trello Lists If you want to monitor multiple Trello lists, use the following configuration (note the difference in list):\ntrello: accessToken: \u0026#34;7b8b14f8743a408a93276d7155dd9ee2\u0026#34; apiKey: \u0026#34;3276d7155dd9ee27b8b14f8743a408a9\u0026#34; board: Main enabled: true list: [\u0026#34;Todo\u0026#34;, \u0026#34;Done\u0026#34;] position: height: 1 left: 2 top: 0 width: 1 refreshInterval: 3600 username: myname Attributes accessToken Value: Your Trello access token.\napiKey Value: Your Trello API key.\nboard The name of the Trello board. enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nlist The Trello lists to fetch cards from. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\nusername Your Trello username. position Where in the grid this module\u0026rsquo;s widget will be displayed. "
|
|
},
|
|
{
|
|
"uri": "/posts/modules/gcal/",
|
|
"title": "Google Calendar",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Displays your upcoming Google calendar events.\nNot: Setting up access to Google Calendars for Go is a bit unobvious. Check out Google\u0026rsquo;s Go Quickstart first and if you have problems, then take a look at this comment by WesleydeSouza which offers a slightly different approach.\nSource Code wtf/gcal/ Required ENV Variables None.\nKeyboard Commands None.\nConfiguration gcal: colors: title: \u0026#34;red\u0026#34; description: \u0026#34;lightblue\u0026#34; highlights: - [\u0026#39;1on1|1\\/11\u0026#39;, \u0026#39;green\u0026#39;] - [\u0026#39;apple|google|aws\u0026#39;, \u0026#39;blue\u0026#39;] - [\u0026#39;interview|meet\u0026#39;, \u0026#39;magenta\u0026#39;] - [\u0026#39;lunch\u0026#39;, \u0026#39;yellow\u0026#39;] past: \u0026#34;gray\u0026#34; conflictIcon: \u0026#34;🚨\u0026#34; currentIcon: \u0026#34;💥\u0026#34; displayResponseStatus: true email: \u0026#34;chriscummer@me.com\u0026#34; enabled: true eventCount: 12 multiCalendar: true position: top: 0 left: 0 height: 4 width: 1 refreshInterval: 300 secretFile: \u0026#34;~/.config/wtf/gcal/client_secret.json\u0026#34; showDeclined: true withLocation: true Attributes colors.title The default colour for calendar event titles. Values: Any X11 color name.\ncolors.description The default color for calendar event descriptions. Values: Any X11 color name.\ncolors.highlights A list of arrays that define a regular expression pattern and a color. If a calendar event title matches a regular expression, the title will be drawn in that colour. Over-rides the default title colour. Values: [a valid regular expression, any X11 color name.]\ncolors.past The color for calendar events that have passed. Values: Any X11 color name.\nconflictIcon The icon displayed beside calendar events that have conflicting times (they intersect or overlap in some way). Values: Any displayable unicode character.\ncurrentIcon The icon displayed beside the current calendar event. Values: Any displayable unicode character.\ndisplayLocation Whether or not to display the location of the calendar event. Values: true, false.\ndisplayResponseStatus Whether or not to display your response status to the calendar event. Values: true, false.\nemail The email address associated with your Google account. Necessary for determining responseStatus. Values: A valid email address string.\nenabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false.\neventCount The number of calendar events to display. Values: A positive integer, 0..n.\nmultiCalendar Whether or not to display your primary calendar or all calendars you have access to. Values: true, or false\nposition Where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\nsecretFile Your Google client secret JSON file. Values: A string representing a file path to the JSON secret file.\nshowDeclined Optional. Whether or not to display events you\u0026rsquo;ve declined to attend. Values: true, or false\nwithLocation Whether or not to show the location of the appointment. Values: true, or false\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/github/",
|
|
"title": "GitHub",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Displays information about your git repositories hosted on GitHub:\nOpen Review Requests All open code review requests assigned to you.\nOpen Pull Requests All open pull requests created by you.\nSource Code wtf/github/ Keyboard Commands Key: / Action: Open/close the widget\u0026rsquo;s help window.\nKey: h Action: Show the previous git repository.\nKey: l Action: Show the next git repository.\nKey: ← Action: Show the previous git repository.\nKey: → Action: Show the next git repository.\nConfiguration github: apiKey: \u0026#34;3276d7155dd9ee27b8b14f8743a408a9\u0026#34; baseURL: \u0026#34;\u0026#34; enabled: true enableStatus: true position: top: 2 left: 3 height: 2 width: 2 refreshInterval: 300 repositories: wesker-api: \u0026#34;UmbrellaCorp\u0026#34; wtf: \u0026#34;senorprogrammer\u0026#34; uploadURL: \u0026#34;\u0026#34; username: \u0026#34;senorprogrammer\u0026#34; Attributes apiKey Value: Your GitHub API token.\nbaseURL Optional Value: Your GitHub Enterprise API URL.\nenabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nenableStatus Display pull request mergeability status (\u0026lsquo;dirty\u0026rsquo;, \u0026lsquo;clean\u0026rsquo;, \u0026lsquo;unstable\u0026rsquo;, \u0026lsquo;blocked\u0026rsquo;).\nValues: true, false.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\nrepositories A list of key/value pairs each describing a GitHub repository to fetch data for. Key: The name of the repository. Value: The name of the account or organization that owns the repository.\nuploadURL Optional Value: Your GitHub Enterprise upload URL (often the same as API URL).\nusername Your GitHub username. Used to figure out which review requests you\u0026rsquo;ve been added to.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/git/",
|
|
"title": "Git",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Displays information about local git repositories: branch, changed files, and recent commits.\nBranch The name of the currently-active git branch.\nChanged Files A list of all the files that have changed since the last commit, and their status.\nRecent Commits A list of n recent commits, who committed it, and when.\nSource Code wtf/git/ Required ENV Variables None.\nKeyboard Commands Key: / Action: Open/close the widget\u0026rsquo;s help window.\nKey: h Action: Show the previous git repository.\nKey: l Action: Show the next git repository.\nKey: ← Action: Show the previous git repository.\nKey: → Action: Show the next git repository.\nConfiguration git: commitCount: 5 commitFormat: \u0026#34;[forestgreen]%h [grey]%cd [white]%s [grey]%an[white]\u0026#34; dateFormat: \u0026#34;%H:%M %d %b %y\u0026#34; enabled: true position: top: 0 left: 3 height: 2 width: 2 refreshInterval: 8 repositories: - \u0026#34;/Users/chris/go/src/github.com/senorprogrammer/wtf\u0026#34; - \u0026#34;/Users/user/fakeapp\u0026#34; Attributes commitCount The number of past commits to display. Values: A positive integer, 0..n.\ncommitFormat Optional The string format for the commit message. dateFormat Optional The string format for the date/time in the commit message. enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\nrepositories Defines which git repositories to watch. Values: A list of zero or more local file paths pointing to valid git repositories.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/weather/",
|
|
"title": "Weather",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Displays a configurable list of current weather report, including current temperature, sunrise time, and sunset time.\nSource Code wtf/weather/ Required ENV Variables Key: WTF_OWM_API_KEY Action: Your OpenWeatherMap API key. Note: DEPRECATED. See the apiKey config value, below.\nKeyboard Commands Key: / Action: Open/close the widget\u0026rsquo;s help window.\nKey: h Action: Show the previous weather location.\nKey: l Action: Show the next weather location.\nKey: ← Action: Show the previous weather location.\nKey: → Action: Show the next weather location.\nConfiguration weather: apiKey: \u0026#34;2dfb3e3650a1950adddb6badf5ba1aaa\u0026#34; # From http://openweathermap.org/help/city_list.txt cityids: - 6173331 - 3128760 - 6167865 - 6176823 colors: current: \u0026#34;lightblue\u0026#34; enabled: true language: \u0026#34;EN\u0026#34; position: top: 0 left: 2 height: 1 width: 1 refreshInterval: 900 tempUnit: \u0026#34;C\u0026#34; Attributes apiKey Your OpenWeatherMap API key.\ncityids A list of the OpenWeatherMap city IDs for the cities you want to view. Values: A list of positive integers, 0..n\ncolors.current The color to highlight the current temperature in. Values: Any X11 color name.\nenabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nlanguage The human language in which to present the weather data. Values: Any language identifier specified by OpenWeatherMap.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\ntempUnit The temperature scale in which to display temperature values. Values: F for Fahrenheit, C for Celcius.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/textfile/",
|
|
"title": "Textfile",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Displays the contents of the specified text file in the widget.\nSource Code wtf/textfile/ Required ENV Variables None.\nKeyboard Commands Key: / Action: Open/close the widget\u0026rsquo;s help window.\nKey: o Action: Opens the text file in whichever text editor is associated with that file type.\nConfiguration textfile: enabled: true filePath: \u0026#34;~/Desktop/notes.md\u0026#34; 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. Values: true, false.\nfilePath The path to the file to be displayed in the widget. position Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/newrelic/",
|
|
"title": "New Relic",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Connects to the New Relic API and displays the last n deploys of the monitored application: deploy ID, deploy time, and who deployed it.\nSource Code wtf/newrelic/ Keyboard Commands None.\nConfiguration newrelic: apiKey: \u0026#34;3276d7155dd9ee27b8b14f8743a408a9\u0026#34; applicationId: 10549735 deployCount: 6 enabled: true position: top: 4 left: 3 height: 1 width: 2 refreshInterval: 900 Attributes apiKey Value: Your New Relic API token.\napplicationId The integer ID of the New Relic application you wish to report on. Values: A positive integer, 0..n.\ndeployCount The number of past deploys to display on screen. Values: A positive integer, 0..n.\nenabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/opsgenie/",
|
|
"title": "OpsGenie",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Connects to the OpsGenie API and displays all your scheduled rotations and who\u0026rsquo;s currently on call.\nSource Code wtf/opsgenie/ Keyboard Commands None.\nConfiguration opsgenie: apiKey: \u0026#34;3276d7155dd9ee27b8b14f8743a408a9\u0026#34; displayEmpty: false enabled: true position: top: 2 left: 1 height: 2 width: 1 refreshInterval: 21600 Attributes apiKey \u0026lt; br /\u0026gt; Value: Your OpsGenie API token.\ndisplayEmpty Whether schedules with no assigned person on-call should be displayed. Values: true, false.\nenabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nposition Where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/security/",
|
|
"title": "Security",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Displays some general information about the state of the machine\u0026rsquo;s wifi connection, firewall, DNS settings, and logged-in users.\nWifi 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 Users Which users are logged into the machine. Note: Does not yet show hidden users. Source Code wtf/security/ Required ENV Variables None.\nKeyboard Commands None.\nConfiguration security: enabled: true position: top: 1 left: 2 height: 1 width: 1 refreshInterval: 3600 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/bamboohr/",
|
|
"title": "BambooHR",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Connects to the BambooHR API and displays who will be Away today.\nSource Code wtf/bamboohr/ Keyboard Commands None.\nConfiguration bamboohr: apiKey: \u0026#34;3276d7155dd9ee27b8b14f8743a408a9\u0026#34; enabled: true position: top: 0 left: 1 height: 2 width: 1 refreshInterval: 900 subdomain: \u0026#34;testco\u0026#34; Attributes apiKey Value: Your BambooHR API token.\nenabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: Any positive integer, 0..n.\nsubdomain Value: Your BambooHR API subdomain name.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/clocks/",
|
|
"title": "Clocks",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Displays a configurable list of world clocks, the local time, and date.\nSource Code wtf/clocks/ Required ENV Variables None.\nKeyboard Commands None.\nConfiguration clocks: colors: rows: even: \u0026#34;lightblue\u0026#34; odd: \u0026#34;white\u0026#34; enabled: true locations: # From https://en.wikipedia.org/wiki/List_of_tz_database_time_zones Avignon: \u0026#34;Europe/Paris\u0026#34; Barcelona: \u0026#34;Europe/Madrid\u0026#34; Dubai: \u0026#34;Asia/Dubai\u0026#34; New York: \u0026#34;America/New York\u0026#34; Toronto: \u0026#34;America/Toronto\u0026#34; UTC: \u0026#34;Etc/UTC\u0026#34; Vancouver: \u0026#34;America/Vancouver\u0026#34; position: top: 4 left: 0 height: 1 width: 1 refreshInterval: 15 # Valid options are: alphabetical, chronological sort: \u0026#34;alphabetical\u0026#34; Attributes colors.rows.even The foreground color for even-numbered rows. Values: Any X11 color name.\ncolors.rows.odd The foreground color for the odd-numbered rows. Values: Any X11 color name.\nenabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nlocations Defines the timezones for the world clocks that you want to display. key is a unique label that will be displayed in the UI. value is a timezone name. Values: Any TZ database timezone.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed.\nrefreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\nsort Defines the display order of the clocks in the widget. Values: alphabetical or chronological. alphabetical will sort in acending order by key, chronological will sort in ascending order by date/time.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/modules/",
|
|
"title": "Modules",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": "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.\nFor example, the New Relic module uses New Relic\u0026rsquo;s API to retrieve a list of the latest deploys and packages that information as a list for display in the \u0026ldquo;New Relic\u0026rdquo; widget.\nThe Clocks module takes a list of timezones and packages that information as a list of city/time pairs for display in the \u0026ldquo;Clocks\u0026rdquo; widget.\nSee available modules at left.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/glossary/",
|
|
"title": "Glossary",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Module A discreet unit of data collection and display. A data interface concept. A package inside the app.\nExamples: New Relic, Git, Weather.\nWidget The onscreen representation of a Module. The widget is responsible for being the interface between the app and the data collection.\nWidgets are defined by a required widget.go file in a Module.\n"
|
|
},
|
|
{
|
|
"uri": "/posts/configuration/",
|
|
"title": "Configuration",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": " Index Configuration Files Environment (ENV) Variables Grid Layout Configuration Files By default WTF looks in a ~/.config/wtf/ directory for a YAML file called config.yml. If the ~/.config/wtf/ directory doesn\u0026rsquo;t exist, WTF will create that directory on start-up, and then display instructions for creating a new configuration file.\nIn other words, WTF expects to have a YAML config file at: ~/.config/wtf/config.yml.\nExample Configuration Files A couple of example config files are provided in the _sample_configs/ directory of the Git repository.\nTo try out WTF quickly, copy simple_config.yml into ~/.config/wtf/ as config.yml and relaunch WTF. You should see the app launch and display the Security, Clocks and Status widgets onscreen.\nCustom Configuration Files To try out different configurations (or run multiple instances of WTF), you can pass the path to a config file via command line arguments on start-up.\nTo load a custom configuration file (ie: one that\u0026rsquo;s not ~/.config/wtf/config.yml), pass in the path to configuration file as a parameter on launch:\n$\u0026gt; wtf --config=path/to/custom/config.yml Configuration Attributes A number of top-level attributes can be set to customize your WTF install. See Attributes for details.\nEnvironment (ENV) Variables Some modules require the presence of environment variables to function properly. Usually these are API keys or other sensitive data that one wouldn\u0026rsquo;t want to have laying about in the config files.\nFor modules that require them, the name of the required environment variable(s) can be found in that module\u0026rsquo;s \u0026ldquo;Required ENV Variables\u0026rdquo; section of the documentation. See OpsGenie for an example.\nGrid Layout WTF uses the Grid layout system from tview to position widgets onscreen. It\u0026rsquo;s not immediately obvious how this works, so here\u0026rsquo;s an explanation:\nThink of your terminal screen as a matrix of letter positions, say 100 chrs wide and 58 chrs tall.\nColumns breaks up the width of the screen into chunks, each chunk a specified number of characters wide. use\n[10, 10, 10, 10, 10, 10, 10, 10, 10, 10]\nTen columns that are ten characters wide\nRows break up the height of the screen into chunks, each chunk a specified number of characters tall. If we wanted to have five rows:\n[10, 10, 10, 10, 18]\nThe co-ordinate system starts at top-left and defines how wide and tall a widget is. If we wanted to put a 2-col, 2-row widget in the bottom of the screen, we\u0026rsquo;d position it at:\n top: 4 // top starts in the 4th row left: 9 // left starts in the 9th column height: 2 // span down rows 4 \u0026amp; 5 (18 characters in size, total) width: 2 // span across cols 9 \u0026amp; 10 (20 characters in size, total) "
|
|
},
|
|
{
|
|
"uri": "/categories/",
|
|
"title": "Categories",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": ""
|
|
},
|
|
{
|
|
"uri": "/posts/",
|
|
"title": "Posts",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": ""
|
|
},
|
|
{
|
|
"uri": "/tags/",
|
|
"title": "Tags",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": ""
|
|
},
|
|
{
|
|
"uri": "/",
|
|
"title": "WTF - the terminal dashboard",
|
|
"tags": [],
|
|
"description": "",
|
|
"content": ""
|
|
}] |