├── .gitignore ├── README.md ├── docs ├── CNAME ├── blog │ ├── 2019-07-09-rss-for-releases.md │ ├── 2019-07-09-v0-14-0.md │ ├── 2019-07-10-wtfutil-release.md │ ├── 2019-07-12-homebrew-installation.md │ ├── 2019-07-16-v0-17-1.md │ ├── 2019-07-20-v0-18-0.md │ ├── 2019-07-27-v0-19-0.md │ ├── 2019-07-31-v0-19-1.md │ ├── 2019-08-20-v0-20-0.md │ ├── 2019-08-29-v0-21-0.md │ ├── 2019-09-12-v0-22-0.md │ ├── 2019-10-11-v0-23-0.md │ ├── 2019-11-10-v0-24-0.md │ ├── 2020-02-04-v0-26-0.md │ ├── 2020-02-23-v0-27-0.md │ ├── 2020-03-15-v0-28-0.md │ ├── 2020-04-26-v0-29-0.md │ ├── 2020-09-23-v0-32-0.md │ ├── 2020-10-13-v0-33-0.md │ ├── 2020-11-08-v0-34-0.md │ ├── 2021-01-03-v0-35-0.md │ ├── 2021-03-23-v0-36-0.md │ ├── 2021-09-06-v0-39-0.md │ ├── 2021-11-02-v0-40-0.md │ ├── home.md │ └── monochrome-retro-display.md ├── configuration │ ├── advanced.md │ ├── common_settings.md │ ├── files.md │ ├── global_settings.md │ └── grid_layout.md ├── development │ └── creating_new_modules.md ├── glossary.md ├── index.md ├── installation.md ├── modules │ ├── airbrake.md │ ├── asana.md │ ├── azure_devops.md │ ├── bamboohr.md │ ├── bargraph.md │ ├── buildkite.md │ ├── cds │ │ ├── favorites.md │ │ ├── queue.md │ │ └── status.md │ ├── circleci.md │ ├── clocks.md │ ├── cmdrunner.md │ ├── covid.md │ ├── cryptocurrencies │ │ ├── bittrex.md │ │ ├── blockfolio.md │ │ ├── cryptolive.md │ │ └── mempool.md │ ├── datadog.md │ ├── devto.md │ ├── digitalclock.md │ ├── digitalocean.md │ ├── docker.md │ ├── feedreader.md │ ├── gerrit.md │ ├── git.md │ ├── github.md │ ├── gitlab.md │ ├── gitlabtodo.md │ ├── gitter.md │ ├── google │ │ ├── analytics.md │ │ ├── gcal.md │ │ └── spreadsheet.md │ ├── hackernews.md │ ├── healthchecks.md │ ├── hibp.md │ ├── index.md │ ├── ipaddress │ │ ├── ipapi.md │ │ └── ipinfo.md │ ├── jenkins.md │ ├── jira.md │ ├── krisinformation.md │ ├── kubernetes.md │ ├── logger.md │ ├── lunarphase.md │ ├── mercurial.md │ ├── newrelic.md │ ├── nextbus.md │ ├── opsgenie.md │ ├── pagerduty.md │ ├── pihole.md │ ├── pocket.md │ ├── power.md │ ├── resourceusage.md │ ├── rollbar.md │ ├── security.md │ ├── sports │ │ ├── football.md │ │ └── nbascore.md │ ├── spotify.md │ ├── stocks │ │ ├── finnhub.md │ │ └── yfinance.md │ ├── subreddit.md │ ├── textfile.md │ ├── todo.md │ ├── todoist.md │ ├── transmission.md │ ├── travisci.md │ ├── trello.md │ ├── twitch.md │ ├── twitter │ │ ├── stats.md │ │ └── tweets.md │ ├── updown.md │ ├── uptimerobot.md │ ├── urlcheck.md │ ├── victorops.md │ ├── weather_services │ │ ├── arpansagovau.md │ │ ├── prettyweather.md │ │ └── weather.md │ └── zendesk.md ├── overrides │ ├── assets │ │ ├── display_screenshot.png │ │ ├── exit_message.png │ │ ├── ghsponsors.svg │ │ ├── logo.png │ │ ├── modules │ │ │ ├── airbrake.png │ │ │ ├── arpansa.png │ │ │ ├── asana.png │ │ │ ├── bittrex.png │ │ │ ├── blockfolio.png │ │ │ ├── cds_favorites.png │ │ │ ├── cds_queue.png │ │ │ ├── cds_status.png │ │ │ ├── circleci.png │ │ │ ├── clocks.png │ │ │ ├── cmdrunner │ │ │ │ ├── iStats.png │ │ │ │ ├── slackstatus.png │ │ │ │ └── wego.png │ │ │ ├── cryptolive.png │ │ │ ├── datadog_error.png │ │ │ ├── datadog_ok.png │ │ │ ├── devto.png │ │ │ ├── digitalclock-small.png │ │ │ ├── digitalclock.png │ │ │ ├── digitalocean.png │ │ │ ├── digitalocean_droplet_info.png │ │ │ ├── docker.png │ │ │ ├── feedreader.png │ │ │ ├── football.png │ │ │ ├── gcal.png │ │ │ ├── gerrit.png │ │ │ ├── git.png │ │ │ ├── github.png │ │ │ ├── gitlab.png │ │ │ ├── gitter.png │ │ │ ├── google_analytics.png │ │ │ ├── hackernews.png │ │ │ ├── healthchecks.png │ │ │ ├── hibp.png │ │ │ ├── ipinfo.png │ │ │ ├── jenkins.png │ │ │ ├── jira.png │ │ │ ├── krisinformation.png │ │ │ ├── lunarphase-fr.png │ │ │ ├── lunarphase.png │ │ │ ├── mempool.png │ │ │ ├── mercurial.png │ │ │ ├── newrelic.png │ │ │ ├── nextbus.png │ │ │ ├── opsgenie.png │ │ │ ├── pihole.png │ │ │ ├── power.png │ │ │ ├── prettyweather.png │ │ │ ├── resource_usage.png │ │ │ ├── rollbar.png │ │ │ ├── security.png │ │ │ ├── subreddit.png │ │ │ ├── textfile.png │ │ │ ├── todo.png │ │ │ ├── todoist.png │ │ │ ├── transmission.png │ │ │ ├── travisci.png │ │ │ ├── trello.png │ │ │ ├── updown.png │ │ │ ├── url_check.png │ │ │ ├── weather-compact.png │ │ │ └── weather.png │ │ ├── screenshot.png │ │ ├── services │ │ │ ├── digitalocean.png │ │ │ ├── docker.png │ │ │ ├── gcal.png │ │ │ ├── git.png │ │ │ ├── github.png │ │ │ ├── pagerduty.jpg │ │ │ ├── pihole.png │ │ │ ├── transmission.png │ │ │ ├── twitter.png │ │ │ └── weather.jpg │ │ └── sponsors │ │ │ ├── airbrake.png │ │ │ ├── robusta.png │ │ │ ├── warp.png │ │ │ ├── warp2.png │ │ │ └── warp3.png │ ├── home.html │ └── main.html ├── quick_start.md ├── sponsors │ ├── exit_message.md │ └── sponsoring.md └── uninstallation.md ├── mkdocs.yml ├── requirements.txt ├── site ├── 404.html ├── CNAME ├── assets │ ├── display_screenshot.png │ ├── exit_message.png │ ├── ghsponsors.svg │ ├── images │ │ └── favicon.png │ ├── javascripts │ │ ├── bundle.5a2dcb6a.min.js │ │ ├── bundle.5a2dcb6a.min.js.map │ │ ├── extra │ │ │ ├── bundle.5f09fbc3.min.js │ │ │ └── bundle.5f09fbc3.min.js.map │ │ ├── lunr │ │ │ ├── min │ │ │ │ ├── lunr.ar.min.js │ │ │ │ ├── lunr.da.min.js │ │ │ │ ├── lunr.de.min.js │ │ │ │ ├── lunr.du.min.js │ │ │ │ ├── lunr.es.min.js │ │ │ │ ├── lunr.fi.min.js │ │ │ │ ├── lunr.fr.min.js │ │ │ │ ├── lunr.hi.min.js │ │ │ │ ├── lunr.hu.min.js │ │ │ │ ├── lunr.it.min.js │ │ │ │ ├── lunr.ja.min.js │ │ │ │ ├── lunr.jp.min.js │ │ │ │ ├── lunr.ko.min.js │ │ │ │ ├── lunr.multi.min.js │ │ │ │ ├── lunr.nl.min.js │ │ │ │ ├── lunr.no.min.js │ │ │ │ ├── lunr.pt.min.js │ │ │ │ ├── lunr.ro.min.js │ │ │ │ ├── lunr.ru.min.js │ │ │ │ ├── lunr.stemmer.support.min.js │ │ │ │ ├── lunr.sv.min.js │ │ │ │ ├── lunr.ta.min.js │ │ │ │ ├── lunr.th.min.js │ │ │ │ ├── lunr.tr.min.js │ │ │ │ ├── lunr.vi.min.js │ │ │ │ └── lunr.zh.min.js │ │ │ ├── tinyseg.js │ │ │ └── wordcut.js │ │ └── workers │ │ │ ├── search.16e2a7d4.min.js │ │ │ └── search.16e2a7d4.min.js.map │ ├── logo.png │ ├── modules │ │ ├── airbrake.png │ │ ├── arpansa.png │ │ ├── asana.png │ │ ├── bittrex.png │ │ ├── blockfolio.png │ │ ├── cds_favorites.png │ │ ├── cds_queue.png │ │ ├── cds_status.png │ │ ├── circleci.png │ │ ├── clocks.png │ │ ├── cmdrunner │ │ │ ├── iStats.png │ │ │ ├── slackstatus.png │ │ │ └── wego.png │ │ ├── cryptolive.png │ │ ├── datadog_error.png │ │ ├── datadog_ok.png │ │ ├── devto.png │ │ ├── digitalclock-small.png │ │ ├── digitalclock.png │ │ ├── digitalocean.png │ │ ├── digitalocean_droplet_info.png │ │ ├── docker.png │ │ ├── feedreader.png │ │ ├── football.png │ │ ├── gcal.png │ │ ├── gerrit.png │ │ ├── git.png │ │ ├── github.png │ │ ├── gitlab.png │ │ ├── gitter.png │ │ ├── google_analytics.png │ │ ├── hackernews.png │ │ ├── healthchecks.png │ │ ├── hibp.png │ │ ├── ipinfo.png │ │ ├── jenkins.png │ │ ├── jira.png │ │ ├── krisinformation.png │ │ ├── lunarphase-fr.png │ │ ├── lunarphase.png │ │ ├── mempool.png │ │ ├── mercurial.png │ │ ├── newrelic.png │ │ ├── nextbus.png │ │ ├── opsgenie.png │ │ ├── pihole.png │ │ ├── power.png │ │ ├── prettyweather.png │ │ ├── resource_usage.png │ │ ├── rollbar.png │ │ ├── security.png │ │ ├── subreddit.png │ │ ├── textfile.png │ │ ├── todo.png │ │ ├── todoist.png │ │ ├── transmission.png │ │ ├── travisci.png │ │ ├── trello.png │ │ ├── updown.png │ │ ├── url_check.png │ │ ├── weather-compact.png │ │ └── weather.png │ ├── screenshot.png │ ├── services │ │ ├── digitalocean.png │ │ ├── docker.png │ │ ├── gcal.png │ │ ├── git.png │ │ ├── github.png │ │ ├── pagerduty.jpg │ │ ├── pihole.png │ │ ├── transmission.png │ │ ├── twitter.png │ │ └── weather.jpg │ ├── sponsors │ │ ├── airbrake.png │ │ ├── robusta.png │ │ ├── warp.png │ │ ├── warp2.png │ │ └── warp3.png │ └── stylesheets │ │ ├── extra.0d2c79a8.min.css │ │ ├── extra.0d2c79a8.min.css.map │ │ ├── main.975780f9.min.css │ │ ├── main.975780f9.min.css.map │ │ ├── palette.2505c338.min.css │ │ └── palette.2505c338.min.css.map ├── blog │ ├── 2019-07-09-rss-for-releases │ │ └── index.html │ ├── 2019-07-09-v0-14-0 │ │ └── index.html │ ├── 2019-07-10-wtfutil-release │ │ └── index.html │ ├── 2019-07-12-homebrew-installation │ │ └── index.html │ ├── 2019-07-16-v0-17-1 │ │ └── index.html │ ├── 2019-07-20-v0-18-0 │ │ └── index.html │ ├── 2019-07-27-v0-19-0 │ │ └── index.html │ ├── 2019-07-31-v0-19-1 │ │ └── index.html │ ├── 2019-08-20-v0-20-0 │ │ └── index.html │ ├── 2019-08-29-v0-21-0 │ │ └── index.html │ ├── 2019-09-12-v0-22-0 │ │ └── index.html │ ├── 2019-10-11-v0-23-0 │ │ └── index.html │ ├── 2019-11-10-v0-24-0 │ │ └── index.html │ ├── 2020-02-04-v0-26-0 │ │ └── index.html │ ├── 2020-02-23-v0-27-0 │ │ └── index.html │ ├── 2020-03-15-v0-28-0 │ │ └── index.html │ ├── 2020-04-26-v0-29-0 │ │ └── index.html │ ├── 2020-09-23-v0-32-0 │ │ └── index.html │ ├── 2020-10-13-v0-33-0 │ │ └── index.html │ ├── 2020-11-08-v0-34-0 │ │ └── index.html │ ├── 2021-01-03-v0-35-0 │ │ └── index.html │ ├── 2021-03-23-v0-36-0 │ │ └── index.html │ ├── 2021-09-06-v0-39-0 │ │ └── index.html │ ├── 2021-11-02-v0-40-0 │ │ └── index.html │ ├── home │ │ └── index.html │ └── monochrome-retro-display │ │ └── index.html ├── configuration │ ├── advanced │ │ └── index.html │ ├── common_settings │ │ └── index.html │ ├── files │ │ └── index.html │ ├── global_settings │ │ └── index.html │ └── grid_layout │ │ └── index.html ├── development │ └── creating_new_modules │ │ └── index.html ├── glossary │ └── index.html ├── index.html ├── installation │ └── index.html ├── modules │ ├── airbrake │ │ └── index.html │ ├── asana │ │ └── index.html │ ├── azure_devops │ │ └── index.html │ ├── bamboohr │ │ └── index.html │ ├── bargraph │ │ └── index.html │ ├── buildkite │ │ └── index.html │ ├── cds │ │ ├── favorites │ │ │ └── index.html │ │ ├── queue │ │ │ └── index.html │ │ └── status │ │ │ └── index.html │ ├── circleci │ │ └── index.html │ ├── clocks │ │ └── index.html │ ├── cmdrunner │ │ └── index.html │ ├── covid │ │ └── index.html │ ├── cryptocurrencies │ │ ├── bittrex │ │ │ └── index.html │ │ ├── blockfolio │ │ │ └── index.html │ │ ├── cryptolive │ │ │ └── index.html │ │ └── mempool │ │ │ └── index.html │ ├── datadog │ │ └── index.html │ ├── devto │ │ └── index.html │ ├── digitalclock │ │ └── index.html │ ├── digitalocean │ │ └── index.html │ ├── docker │ │ └── index.html │ ├── feedreader │ │ └── index.html │ ├── gerrit │ │ └── index.html │ ├── git │ │ └── index.html │ ├── github │ │ └── index.html │ ├── gitlab │ │ └── index.html │ ├── gitlabtodo │ │ └── index.html │ ├── gitter │ │ └── index.html │ ├── google │ │ ├── analytics │ │ │ └── index.html │ │ ├── gcal │ │ │ └── index.html │ │ └── spreadsheet │ │ │ └── index.html │ ├── hackernews │ │ └── index.html │ ├── healthchecks │ │ └── index.html │ ├── hibp │ │ └── index.html │ ├── index.html │ ├── ipaddress │ │ ├── ipapi │ │ │ └── index.html │ │ └── ipinfo │ │ │ └── index.html │ ├── jenkins │ │ └── index.html │ ├── jira │ │ └── index.html │ ├── krisinformation │ │ └── index.html │ ├── kubernetes │ │ └── index.html │ ├── logger │ │ └── index.html │ ├── lunarphase │ │ └── index.html │ ├── mercurial │ │ └── index.html │ ├── newrelic │ │ └── index.html │ ├── nextbus │ │ └── index.html │ ├── opsgenie │ │ └── index.html │ ├── pagerduty │ │ └── index.html │ ├── pihole │ │ └── index.html │ ├── pocket │ │ └── index.html │ ├── power │ │ └── index.html │ ├── resourceusage │ │ └── index.html │ ├── rollbar │ │ └── index.html │ ├── security │ │ └── index.html │ ├── sports │ │ ├── football │ │ │ └── index.html │ │ └── nbascore │ │ │ └── index.html │ ├── spotify │ │ └── index.html │ ├── stocks │ │ ├── finnhub │ │ │ └── index.html │ │ └── yfinance │ │ │ └── index.html │ ├── subreddit │ │ └── index.html │ ├── textfile │ │ └── index.html │ ├── todo │ │ └── index.html │ ├── todoist │ │ └── index.html │ ├── transmission │ │ └── index.html │ ├── travisci │ │ └── index.html │ ├── trello │ │ └── index.html │ ├── twitch │ │ └── index.html │ ├── twitter │ │ ├── stats │ │ │ └── index.html │ │ └── tweets │ │ │ └── index.html │ ├── updown │ │ └── index.html │ ├── uptimerobot │ │ └── index.html │ ├── urlcheck │ │ └── index.html │ ├── victorops │ │ └── index.html │ ├── weather_services │ │ ├── arpansagovau │ │ │ └── index.html │ │ ├── prettyweather │ │ │ └── index.html │ │ └── weather │ │ │ └── index.html │ └── zendesk │ │ └── index.html ├── overrides │ ├── assets │ │ ├── display_screenshot.png │ │ ├── exit_message.png │ │ ├── ghsponsors.svg │ │ ├── logo.png │ │ ├── modules │ │ │ ├── airbrake.png │ │ │ ├── arpansa.png │ │ │ ├── asana.png │ │ │ ├── bittrex.png │ │ │ ├── blockfolio.png │ │ │ ├── cds_favorites.png │ │ │ ├── cds_queue.png │ │ │ ├── cds_status.png │ │ │ ├── circleci.png │ │ │ ├── clocks.png │ │ │ ├── cmdrunner │ │ │ │ ├── iStats.png │ │ │ │ ├── slackstatus.png │ │ │ │ └── wego.png │ │ │ ├── cryptolive.png │ │ │ ├── datadog_error.png │ │ │ ├── datadog_ok.png │ │ │ ├── devto.png │ │ │ ├── digitalclock-small.png │ │ │ ├── digitalclock.png │ │ │ ├── digitalocean.png │ │ │ ├── digitalocean_droplet_info.png │ │ │ ├── docker.png │ │ │ ├── feedreader.png │ │ │ ├── football.png │ │ │ ├── gcal.png │ │ │ ├── gerrit.png │ │ │ ├── git.png │ │ │ ├── github.png │ │ │ ├── gitlab.png │ │ │ ├── gitter.png │ │ │ ├── google_analytics.png │ │ │ ├── hackernews.png │ │ │ ├── healthchecks.png │ │ │ ├── hibp.png │ │ │ ├── ipinfo.png │ │ │ ├── jenkins.png │ │ │ ├── jira.png │ │ │ ├── krisinformation.png │ │ │ ├── lunarphase-fr.png │ │ │ ├── lunarphase.png │ │ │ ├── mempool.png │ │ │ ├── mercurial.png │ │ │ ├── newrelic.png │ │ │ ├── nextbus.png │ │ │ ├── opsgenie.png │ │ │ ├── pihole.png │ │ │ ├── power.png │ │ │ ├── prettyweather.png │ │ │ ├── resource_usage.png │ │ │ ├── rollbar.png │ │ │ ├── security.png │ │ │ ├── subreddit.png │ │ │ ├── textfile.png │ │ │ ├── todo.png │ │ │ ├── todoist.png │ │ │ ├── transmission.png │ │ │ ├── travisci.png │ │ │ ├── trello.png │ │ │ ├── updown.png │ │ │ ├── url_check.png │ │ │ ├── weather-compact.png │ │ │ └── weather.png │ │ ├── screenshot.png │ │ ├── services │ │ │ ├── digitalocean.png │ │ │ ├── docker.png │ │ │ ├── gcal.png │ │ │ ├── git.png │ │ │ ├── github.png │ │ │ ├── pagerduty.jpg │ │ │ ├── pihole.png │ │ │ ├── transmission.png │ │ │ ├── twitter.png │ │ │ └── weather.jpg │ │ └── sponsors │ │ │ ├── airbrake.png │ │ │ ├── robusta.png │ │ │ ├── warp.png │ │ │ ├── warp2.png │ │ │ └── warp3.png │ ├── home.html │ └── main.html ├── quick_start │ └── index.html ├── search │ └── search_index.json ├── sitemap.xml ├── sitemap.xml.gz ├── sponsors │ ├── exit_message │ │ └── index.html │ └── sponsoring │ │ └── index.html └── uninstallation │ └── index.html └── snippets ├── attributes ├── _template.html ├── apikey.md ├── border.md ├── colors │ ├── background.html │ ├── border │ │ ├── focusable.md │ │ ├── focused.md │ │ └── normal.md │ ├── custom.md │ ├── highlight.html │ ├── highlight.md │ └── rows.md ├── custom.md ├── dateFormat.md ├── email.md ├── enabled.md ├── focus_char.md ├── focusable.md ├── global │ ├── exit_message │ │ ├── display.md │ │ └── github_api_key.md │ ├── grid │ │ ├── columns.md │ │ └── rows.md │ ├── nav_shortcuts.md │ ├── open_file_util.md │ ├── open_url_util.md │ └── term.md ├── hourFormat.md ├── password.md ├── position.md ├── refreshInterval.md ├── table_header.md ├── timezone.md ├── title.md ├── username.md ├── verifyServerCert.md └── wrapText.md ├── keyboard ├── a.md ├── arrowBack.md ├── arrowDown.md ├── arrowFore.md ├── arrowUp.md ├── b.md ├── c.md ├── ctrlD.md ├── ctrlF.md ├── ctrlJ.md ├── ctrlK.md ├── ctrlL.md ├── d.md ├── e.md ├── esc.md ├── f.md ├── foreslash.md ├── g.md ├── h.md ├── i.md ├── insert.md ├── j.md ├── k.md ├── l.md ├── m.md ├── n.md ├── o.md ├── p.md ├── pound.md ├── q.md ├── questionmark.md ├── r.md ├── return.md ├── s.md ├── space.md ├── spacer.md ├── t.md ├── table_header.md ├── u.md ├── v.md ├── w.md ├── x.md ├── y.md └── z.md ├── src_path.md └── test.md /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | .idea/ 3 | venv/ 4 | virtual-env/ -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # WTF Docs 2 | 3 | This site is built using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/). 4 | 5 | ### Development environment setup 6 | 7 | 1. Install python 3 8 | 2. Create a virtual-env: 9 | ```bash 10 | python -m venv virtual-env 11 | source virtual-env/bin/activate 12 | ``` 13 | 3. `pip install -r requirements.txt` 14 | 4. `mkdocs serve` 15 | 16 | ### To add documentation for a new module 17 | 18 | 1. Create a new [Markdown](https://guides.github.com/features/mastering-markdown/) file in the `/docs/modules` directory 19 | 2. Add a new route in the `mkdocs.yml` file, under the `nav:` section. 20 | 3. To add pictures, add the image to `./docs/overrides/assets/modules/.png` 21 | 22 | ### Deploying 23 | 24 | * Merge changes into `master` 25 | * Run `mkdocs gh-deploy --force` to push the changes to the `gh-pages` branch on github.com 26 | * Commit the resulting changes into `master` 27 | -------------------------------------------------------------------------------- /docs/CNAME: -------------------------------------------------------------------------------- 1 | wtfutil.com 2 | -------------------------------------------------------------------------------- /docs/blog/2019-07-09-rss-for-releases.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Using WTF's FeedReader to Track WTF Releases" 3 | date: 2019-07-09T17:07:58-07:00 4 | description: "Cats and dogs" 5 | draft: false 6 | --- 7 | 8 | {{ page.meta.date }} 9 | 10 | With the release of [v0.14.0](https://github.com/wtfutil/wtf/releases/tag/v0.14.0), WTF has the ability to track and display RSS and Atom feeds via the [FeedReader module](/modules/feedreader/). 11 | 12 | And if you're reading this, you know that [wtfutil.com](https://wtfutil.com) now has a blog, and that blog is available via RSS at [https://wtfutil.com/blog/index.xml](https://wtfutil.com/blog/index.xml). 13 | 14 | Putting the two together, you now have a great way to keep up-to-date on the most recent WTF releases, because all of them will be announced, with changlog details, on this very blog. 15 | 16 | To configure WTF to do so, add the following `feedreader` configuration to your `config.yml` file: 17 | 18 | ```bash 19 | feedreader: 20 | enabled: true 21 | feeds: 22 | - https://wtfutil.com/blog/index.xml 23 | feedLimit: 10 24 | position: 25 | top: 2 26 | left: 1 27 | width: 2 28 | height: 1 29 | updateInterval: 14400 30 | ``` 31 | 32 | Modify the `position` values accordingly for where you want it to appear onscreen. 33 | 34 | `feedLimit` limits the number of stories displayed for any given feed. Without a feed limit, FeedReader will display all the stories returned by the feed. 35 | 36 | I've set `updateInterval` to a fairly reasonable 14,400 seconds, or four hours, because most RSS content doesn't change that often. -------------------------------------------------------------------------------- /docs/blog/2019-07-09-v0-14-0.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "v0.14.0 Released" 3 | date: 2019-07-09T14:41:58-07:00 4 | draft: false 5 | --- 6 | 7 | {{ page.meta.date }} 8 | 9 | [v0.14.0](https://github.com/wtfutil/wtf/releases/tag/v0.14.0) contains the following changes: 10 | 11 | * CmdRunner module now supports custom titles 12 | * FeedReader module added 13 | * Cryptolive module works again 14 | * gCal module now supports setting an explicit time zone via the "timezone" config attribute 15 | * Misconfigured module positions in `config.yaml` now attempt to provide informative error messages on launch -------------------------------------------------------------------------------- /docs/blog/2019-07-10-wtfutil-release.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Binary Renamed to 'wtfutil'" 3 | date: 2019-07-10T10:09:34-07:00 4 | draft: false 5 | --- 6 | 7 | {{ page.meta.date }} 8 | 9 | With the release of [v0.15.0](https://github.com/wtfutil/wtf/releases/tag/v0.15.0), the installed binary has been renamed from `wtf` to `wtfutil`. 10 | 11 | To execute it, you must now use: 12 | 13 | ```bash 14 | wtfutil 15 | ``` 16 | 17 | The name has changed because calling it `wtf` caused a collision with the venerable and amusing [bsd-wtf](https://sourceforge.net/projects/bsdwtf/) utility. This wasn't a problem back when there was only one person using WTF and no one else knew about it, but with the rise in popularity this collision has been causing problems for some people. 18 | 19 | Given that `bsd-wtf` was created long before WTF, it only seems proper to abdicate the name. 20 | 21 | (And if you want to check out the original `wtf`, it's available via [Homebrew](https://formulae.brew.sh/formula/wtf) on macOS, and presumably via `apt-get` on Linux). -------------------------------------------------------------------------------- /docs/blog/2019-07-12-homebrew-installation.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Installing With Homebrew" 3 | date: 2019-07-12T07:27:20-07:00 4 | draft: false 5 | --- 6 | 7 | {{ page.meta.date }} 8 | 9 | As of today WTF can be installed on macOS using [Homebrew](https://brew.sh): 10 | 11 | ```bash 12 | brew tap wtfutil/wtfutil 13 | brew install wtfutil 14 | 15 | wtfutil 16 | ``` 17 | 18 | If everything goes according to plan, you should now find `wtfutil` on your system as an executable binary: 19 | 20 | ```bash 21 | ❯ which wtfutil 22 | /usr/local/bin/wtfutil 23 | ``` 24 | 25 | ```bash 26 | ❯ ls /usr/local/bin/wtfutil 27 | lrwxr-xr-x 1 xxxxxx admin 36 11 Jul 17:29 /usr/local/bin/wtfutil -> ../Cellar/wtfutil/0.16.1/bin/wtfutil 28 | ``` -------------------------------------------------------------------------------- /docs/blog/2019-07-16-v0-17-1.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "v0.17.1 Released" 3 | date: 2019-07-16T18:05:18-07:00 4 | draft: false 5 | --- 6 | 7 | {{ page.meta.date }} 8 | 9 | [v0.17.1](https://github.com/wtfutil/wtf/releases/tag/v0.17.1) contains the following changes: 10 | 11 | * Fixes an issue with the default config file not being created on first run 12 | -------------------------------------------------------------------------------- /docs/blog/2019-07-20-v0-18-0.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "v0.18.0 Released" 3 | date: 2019-07-20T13:16:27-07:00 4 | draft: false 5 | --- 6 | 7 | {{ page.meta.date }} 8 | 9 | [v0.18.0](https://github.com/wtfutil/wtf/releases/tag/v0.18.0) contains the following changes: 10 | 11 | * Adds a Google Analytics module 12 | * Fixes a bug with config file creation that would happen if the `~/.config` directory did not already exist 13 | -------------------------------------------------------------------------------- /docs/blog/2019-07-27-v0-19-0.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "v0.19.0 Released" 3 | date: 2019-07-27T20:13:23-07:00 4 | draft: false 5 | --- 6 | 7 | {{ page.meta.date }} 8 | 9 | [v0.19.0](https://github.com/wtfutil/wtf/releases/tag/v0.19.0) contains the following changes: 10 | 11 | ### ☠️ Breaking Change 12 | 13 | * HIBP module now requires an API key to operate. See [Authentication and the Have I Been Pwned API](https://www.troyhunt.com/authentication-and-the-have-i-been-pwned-api/) for more details, [#508](https://github.com/wtfutil/wtf/issues/508) by [@senorprogrammer](https://github.com/senorprogrammer) 14 | 15 | ### ⚡️ Added 16 | 17 | * OpsGenie module now supports "region" configuration option ("us" or "eu"), by [@l13t](https://github.com/l13t) 18 | 19 | ### 🐞 Fixed 20 | 21 | * Fixes the error message shown when an explicitly-specified custom config file cannot be found or cannot be read, by [@senorprogrammer](https://github.com/senorprogrammer) 22 | * Rollbar module works again, [#507](https://github.com/wtfutil/wtf/issues/507) by [@Seanstoppable](https://github.com/Seanstoppable) 23 | * The default config that gets installed on first run is much improved, [#504](https://github.com/wtfutil/wtf/issues/504) by [@senorprogrammer](https://github.com/senorprogrammer) 24 | * Default config file is now `chmod 0600` to ensure only the owning user can read it, by [@senorprogrammer](https://github.com/senorprogrammer) -------------------------------------------------------------------------------- /docs/blog/2019-07-31-v0-19-1.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "v0.19.1 Released" 3 | date: 2019-07-31T15:06:11-07:00 4 | draft: false 5 | --- 6 | 7 | {{ page.meta.date }} 8 | 9 | [v0.19.1](https://github.com/wtfutil/wtf/releases/tag/v0.19.1) contains the following changes: 10 | 11 | ### ⚡️ Added 12 | 13 | * New versions now include binaries built for `arm` and `arm64` architectures -------------------------------------------------------------------------------- /docs/blog/2019-08-20-v0-20-0.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "v0.20.0 Released" 3 | date: 2019-08-20T07:40:25-07:00 4 | draft: false 5 | --- 6 | 7 | {{ page.meta.date }} 8 | 9 | [v0.20.0](https://github.com/wtfutil/wtf/releases/tag/v0.20.0) contains the following changes: 10 | 11 | ⚡️ Added 12 | 13 | * Kubernetes module 14 | 15 | 🐞 Fixed 16 | 17 | * Tab and Esc keys work properly in modal dialogs 18 | * `wtfutil -m` flag now works with non-enabled modules 19 | * Jenkins job filtering preserved across redraws -------------------------------------------------------------------------------- /docs/blog/2019-08-29-v0-21-0.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "v0.21.0 Released" 3 | date: 2019-08-29T21:48:13-07:00 4 | draft: false 5 | --- 6 | 7 | {{ page.meta.date }} 8 | 9 | [v0.21.0](https://github.com/wtfutil/wtf/releases/tag/v0.21.0) contains the following changes: 10 | 11 | ### ⚡️ Added 12 | 13 | * Power Soure module support added for FreeBSD, by [@hxw](https://github.com/hxw) 14 | 15 | ### 🐞 Fixed 16 | 17 | * Power indicator displays ∞ on Linux when fully-charged and on AC power, [#534](https://github.com/wtfutil/wtf/issues/534) by [@Seanstoppable](https://github.com/Seanstoppable) 18 | * Default background color is now the terminal background color, making transparency support possible in MacOS and Linux, by [@Seanstoppable](https://github.com/Seanstoppable) 19 | * `xdg-open` now used as the opener for HTTP/HTTPS by default, by [@hxw](https://github.com/hxw) 20 | * Transmission port over-ride now working, [#565](https://github.com/wtfutil/wtf/issues/565) by [@Seanstoppable](https://github.com/Seanstoppable) 21 | * Default config is now created on first run, [#553](https://github.com/wtfutil/wtf/issues/553) by [@senorprogrammer](https://github.com/senorprogrammer) -------------------------------------------------------------------------------- /docs/blog/2019-11-10-v0-24-0.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "v0.24.0 Released" 3 | date: 2019-11-10T11:32:32-08:00 4 | draft: false 5 | --- 6 | 7 | {{ page.meta.date }} 8 | 9 | [WTF v0.24.0](https://github.com/wtfutil/wtf/releases/tag/v0.24.0) contains the following changes: 10 | 11 | ### ⚡️ Added 12 | 13 | * Proper, usable [Docker file](https://github.com/wtfutil/wtf/blob/master/Dockerfile) added, by [@Boot-Error](https://github.com/Boot-Error) 14 | * [GitLab](https://wtfutil.com/modules/gitlab/) module displays issues assigned to, and opened by, the user, by [@caalberts](https://github.com/caalberts) 15 | * [TravisCI](https://wtfutil.com/modules/travisci/) now checks for uncommitted vendor changes, by [@indradhanush](https://github.com/indradhanush) 16 | * Football module added, by [@C123R](https://github.com/C123R) 17 | * [resourceuseage](https://wtfutil.com/modules/resourceusage/) now supports a `cpuCombined` setting, by [@madepolli](https://github.com/madepolli) 18 | * [Twitter Stats](https://wtfutil.com/modules/twitter/twittertweets/) module added, by [@Ameobea](https://github.com/Ameobea) 19 | 20 | ### 🐞 Fixed 21 | 22 | * Github PRs do not count against issues, by [@alexfornuto](https://github.com/alexfornuto) 23 | * Todo scrolling now works properly, [#707](https://github.com/wtfutil/wtf/issues/707) by [3mard](https://github.com/3mard) 24 | * Configs with a missing `color` key now load properly, [#718](https://github.com/wtfutil/wtf/issues/718) and [#730](https://github.com/wtfutil/wtf/issues/730) by [@senorprogrammer](https://github.com/senorprogrammer) 25 | -------------------------------------------------------------------------------- /docs/blog/2020-02-23-v0-27-0.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "v0.27.0 Released" 3 | date: 2020-02-23T07:09:07-08:00 4 | draft: false 5 | --- 6 | 7 | {{ page.meta.date }} 8 | 9 | [WTF v0.27.0](https://github.com/wtfutil/wtf/releases/tag/v0.27.0) contains the following changes: 10 | 11 | ### ⚡️ Added 12 | 13 | * GitLab Todo module added, by [@elliotrushton](https://github.com/elliotrushton) 14 | * [CDS](https://wtfutil.com/modules/cds/) module added, by [@yesnault](https://github.com/yesnault) 15 | 16 | ### 🐞 Fixed 17 | 18 | * The `vendor` directory has been removed, [#792](https://github.com/wtfutil/wtf/issues/792) by [@bjoernw](https://github.com/bjoernw) 19 | 20 | ### 👍 Updated 21 | 22 | * Updated `zorkian/go-datadog-api` from 2.26.0+incompatible to 2.27.0+incompatible 23 | * Updated `google.golang.org/api` from 0.15.0 to 0.17.0 24 | * Updated `github.com/nicklaw5/helix` from 0.5.5 to 0.5.7 25 | * Updated `xanzy/go-gitlab` from 0.23.0 to 0.26.0 26 | * Updated `stretchr/testify` from o.4.0 to 0.5.1 -------------------------------------------------------------------------------- /docs/blog/2020-03-15-v0-28-0.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "v0.28.0 Released" 3 | date: 2020-03-15T09:52:57-07:00 4 | draft: false 5 | --- 6 | 7 | {{ page.meta.date }} 8 | 9 | [WTF v0.28.0](https://github.com/wtfutil/wtf/releases/tag/v0.28.0) contains the following changes: 10 | 11 | ### ⚡️ Added 12 | 13 | * Support for customizing CPU, Mem, and Swap display in ResourceUsage, by [@leterio](https://github.com/leterio) 14 | 15 | ### 👍 Updated 16 | 17 | * Now prefers Go 1.14 for compilation (should still work under 1.13 however) 18 | * Updated `shirou/gopsutil` from 2.20.1+incompatible to 2.20.2+incompatible 19 | * Updated `google.golang.org/api` from 0.17.0 to 0.20.0 20 | * Updated `digitalocean/godo` from 1.30.0 to 1.32.0 21 | * Updated `xanzy/go-gitlab` from 0.26.0 to 0.28.0 22 | * Updated `adlio/trello` from 1.6.0 to 1.7.0 23 | * Updated `zorkian/go-datadog-api` from 2.27.0+incompatible to 2.28.0+incompatible -------------------------------------------------------------------------------- /docs/blog/2020-04-26-v0-29-0.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "v0.29.0 Released" 3 | date: 2020-04-26T15:39:14-07:00 4 | draft: false 5 | --- 6 | 7 | {{ page.meta.date }} 8 | 9 | [WTF v0.29.0](https://github.com/wtfutil/wtf/releases/tag/v0.29.0) contains the following changes: 10 | 11 | ### ⚡️ Added 12 | 13 | * gCal module now has a `showEndTime` boolean option for displaying meeting end times, by [@acaloiaro](https://github.com/acaloiaro) 14 | * [Pi-hole](https://wtfutil.com/modules/pihole/) module added, by [@jonhadfield](https://github.com/jonhadfield) 15 | 16 | ### 🐞 Fixed 17 | 18 | * Docker module subheading display, [#847](https://github.com/wtfutil/wtf/issues/847) by [@senorprogrammer](https://github.com/senorprogrammer) 19 | * Improved display of currencies for the Exchange Rate module, by [@indradhanush](https://github.com/indradhanush) 20 | 21 | ### 👍 Updated 22 | 23 | * Updated `nicklaw5/helix` from 0.5.7 to 0.5.8 24 | * Updated `digitalocean/godo` from 1.34.0 to 1.35.1 25 | * Updated `xanzy/go-gitlab` from 0.28.0 to 0.31.0 26 | * Updated `shirou/gopsutil` from 2.20.2+incompatible to 2.20.3+incompatible 27 | * Updated `alecthomas/chroma` from 0.7.1 to 0.7.2 28 | * Updated `google.golang.org/api` from 0.21.0 to 0.22.0 29 | -------------------------------------------------------------------------------- /docs/blog/2020-09-23-v0-32-0.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "v0.32.0 Released" 3 | date: 2020-09-23T21:11:12-07:00 4 | draft: false 5 | --- 6 | 7 | {{ page.meta.date }} 8 | 9 | [WTF v0.23.0](https://github.com/wtfutil/wtf/releases/tag/v0.32.0) contains the following changes: 10 | 11 | ### ⚡️ Added 12 | 13 | * PagerDuty module now supports `showOncallEnd` setting, which determines whether or not to display the oncall rotation end date, by [@senorprogrammer](https://github.com/senorprogrammer) 14 | * Exchange Rates module now supports `precision` setting, which determines how many decimal places to display, [#897](https://github.com/wtfutil/wtf/issues/897) by [@senorprogrammer](https://github.com/senorprogrammer) 15 | 16 | ### 🐞 Fixed 17 | 18 | * Todo module's edit modal now shows up quickly, [#876](https://github.com/wtfutil/wtf/issues/876) by [@aeter](https://github.com/aeter) 19 | * Jira module title now displays properly, [#942](https://github.com/wtfutil/wtf/issues/942) by [@timhwang21](https://github.com/timhwang21) 20 | 21 | ### 👍 Updated 22 | 23 | * Updated `alecthomas/chroma` from 0.7.3 to 0.8.0 24 | * Updated `digitalocean/godo` from 1.38.0 to 1.42.1 25 | * Updated `google.golang.org/api` from 0.29.0 to 0.30.0 26 | * Updated `shirou/gopsutil` from 2.20.6+incompatible to 2.20.7+incompatible -------------------------------------------------------------------------------- /docs/blog/2020-11-08-v0-34-0.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "v0.34.0 Released" 3 | date: 2020-11-08T16:35:07-08:00 4 | draft: false 5 | --- 6 | 7 | {{ page.meta.date }} 8 | 9 | Now [available here](https://github.com/wtfutil/wtf/releases/tag/v0.34.0). 10 | 11 | ### ⚡️ Added 12 | 13 | * DigitalOcean module now supports custom column definitions in the default layout. See [the docs](https://wtfutil.com/modules/digitalocean/) for details, [#986](https://github.com/wtfutil/wtf/issues/986) by [@senorprogrammer](https://github.com/senorprogrammer) 14 | * Finnhub stock quotes module added, [#930](https://github.com/wtfutil/wtf/issues/930) by [@applegreengrape](https://github.com/applegreengrape) 15 | * Grafana Alerts module added, by [@schoentoon](https://github.com/schoentoon) 16 | 17 | ### 👍 Updated 18 | 19 | * Updated `google.golang.org/api` from 0.30.0 to 0.33.0 20 | * Updated `github.com/digitalocean/godo` from 1.46.0 to 1.52.0 21 | * Updated `github.com/xanzy/go-gitlab` from 0.38.1 to 0.39.0 22 | * Updated `github.com/zorkian/go-datadog-api` from 2.29.0+incompatible to 2.30.0+incompatible 23 | * Updated `golang.org/x/text` from 0.3.3 to 0.3.4 24 | -------------------------------------------------------------------------------- /docs/blog/2021-01-03-v0-35-0.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "v0.35.0 Released" 3 | date: 2021-01-03T17:27:07-08:00 4 | draft: false 5 | --- 6 | 7 | {{ page.meta.date }} 8 | 9 | Now [available here](https://github.com/wtfutil/wtf/releases/tag/v0.35.0). 10 | 11 | ## Changelog 12 | 13 | ### ⚡️ Added 14 | 15 | * CircleCI module now supports `numberOfBuilds` setting defining how many builds to display, [#1020](https://github.com/wtfutil/wtf/issues/1020) by [@dabcoder](https://github.com/dabcoder) 16 | * The \\ key now opens module documentation in the browser for the currently-focused module, by [@senorprogrammer](https://github.com/senorprogrammer) 17 | * Krisinformation module added, by [@stone](https://github.com/stone) 18 | * Covid module has been added, by [@dabcoder](https://github.com/dabcoder) 19 | * Support for a "Language" configuration key added. Supports any BCP 47 tag for identifying a langauge, by [@senorprogrammer](https://github.com/senorprogrammer) 20 | 21 | ### 🐞 Fixed 22 | 23 | * CryptoLive prices update again, [#1041](https://github.com/wtfutil/wtf/issues/1041) by [@zye1996](https://github.com/zye1996) 24 | 25 | -------------------------------------------------------------------------------- /docs/blog/2021-03-23-v0-36-0.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "v0.36.0 Released" 3 | date: 2021-03-23T03:42:07-08:00 4 | draft: false 5 | --- 6 | 7 | {{ page.meta.date }} 8 | 9 | Now [available here](https://github.com/wtfutil/wtf/releases/tag/v0.36.0). 10 | 11 | ## Changelog 12 | 13 | ### ⚡️ Added 14 | 15 | * HealthChecks module added, by [@stone](https://github.com/stone) 16 | * Asana module added, by [@xntrik](https://github.com/xntrik) 17 | * Kubernetes module now displays the Ready Replicas and Total Replicas count, by [@LKaemmerling](https://github.com/LKaemmerling) 18 | * Now builds using Go 1.16, which provides support for Apple's M1 ARM hardware, by [@LKaemmerling](https://github.com/LKaemmerling) 19 | 20 | ### 🐞 Fixed 21 | 22 | * Numerous dangling response bodies closed, by [@dabcoder](https://github.com/dabcoder) 23 | * HackerNews read-on-response error fixed, by [@LKaemmerling](https://github.com/LKaemmerling) 24 | * CircleCI read-on-response error fixed, by [@dabcoder](https://github.com/dabcoder) -------------------------------------------------------------------------------- /docs/blog/2021-09-06-v0-39-0.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "v0.39.0 Released" 3 | date: 2021-09-06T13:48:07-08:00 4 | draft: false 5 | --- 6 | 7 | {{ page.meta.date }} 8 | 9 | Now [available here](https://github.com/wtfutil/wtf/releases/tag/v0.39.0). 10 | 11 | ## Changelog 12 | 13 | ### ⚡️ Added 14 | 15 | * Updown module added, by [@hjr265](https://github.com/hjr265) 16 | * Considerable improvements to the Todo module. See PR [#1100](https://github.com/wtfutil/wtf/pull/1100) for details. By [@tadeaspaule](https://github.com/tadeaspaule) 17 | 18 | ### 🐞 Fixed 19 | 20 | * Healthchecks module now respects the `apiURL` setting in the config file, by [@hjr265](https://github.com/hjr265) 21 | * Example FeedReader RSS feed in the default config changed to a working feed, [#1096](https://github.com/wtfutil/wtf/issues/1096) by [@senorprogrammer](https://github.com/senorprogrammer) 22 | -------------------------------------------------------------------------------- /docs/blog/home.md: -------------------------------------------------------------------------------- 1 | # The WTF Blog 2 | 3 | * [2021-11-02 v0.40.0 Released](../2021-11-02-v0-40-0) 4 | 5 |

6 | 7 | * [2021-09-06 v0.39.0 Released](../2021-09-06-v0-39-0) 8 | 9 |

10 | 11 | * [2021-01-03 v0.36.0 Released](../2021-03-23-v0-36-0) 12 | 13 |

14 | 15 | * [2021-01-03 v0.35.0 Released](../2021-01-03-v0-35-0) 16 | 17 |

18 | 19 | * [2020-11-08 v0.34.0 Released](../2020-11-08-v0-34-0) 20 | 21 |

22 | 23 | * [2020-10-13 v0.33.0 Released](../2020-10-13-v0-33-0) 24 | 25 |

26 | 27 | * [2020-09-23 v0.32.0 Released](../2020-09-23-v0-32-0) 28 | 29 |

30 | 31 | * [2020-04-26 v0.29.0 Released](../2020-04-26-v0-29-0) 32 | 33 |

34 | 35 | * [2020-03-15 v0.28.0 Released](../2020-03-15-v0-28-0) 36 | 37 |

38 | 39 | * [2020-02-23 v0.27.0 Released](../2020-02-23-v0-27-0) 40 | * [2020-02-04 v0.26.0 Released](../2020-02-04-v0-26-0) 41 | 42 |

43 | 44 | * [2019-11-10 v0.24.0 Released](../2019-11-10-v0-24-0) 45 | * [2019-11-10 Monochrome Retro Display](../monochrome-retro-display) 46 | 47 |

48 | 49 | * [2019-10-11 v0.23.0 Released](../2019-10-11-v0-23-0) 50 | 51 |

52 | 53 | * [2019-09-12 v0.22.0 Released](../2019-09-12-v0-22-0) 54 | 55 |

56 | 57 | * [2019-08-29 v0.21.0 Released](../2019-08-29-v0-21-0) 58 | * [2019-08-20 v0.20.0 Released](../2019-08-20-v0-20-0) 59 | 60 |

61 | 62 | * [2019-07-31 v0.19.1 Released](../2019-07-31-v0-19-1) 63 | * [2019-07-27 v0.19.0 Released](../2019-07-27-v0-19-0) 64 | * [2019-07-20 v0.18.0 Released](../2019-07-20-v0-18-0) 65 | * [2019-07-16 v0.17.1 Released](../2019-07-16-v0-17-1) 66 | * [2019-07-12 Homebrew Installation](../2019-07-12-homebrew-installation) 67 | * [2019-07-10 WTFUtil Release](../2019-07-10-wtfutil-release) 68 | * [2019-07-09 v0.14.0 Released](../2019-07-09-v0-14-0) 69 | * [2019-07-09 RSS for Releases](../2019-07-09-rss-for-releases) -------------------------------------------------------------------------------- /docs/blog/monochrome-retro-display.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Monochrome Retro Display" 3 | date: 2019-11-10T11:43:32-08:00 4 | draft: false 5 | --- 6 | 7 | {{ page.meta.date }} 8 | 9 | With v0.24.0, WTF now has better support for theme-like colour settings. It's far from perfect, a lot of modules will have to be improved internally to make theming ubiquitous, but it's a start. 10 | 11 | By way of example, if you're running v0.24 or later, drop this into your config at the top, replace your existing `colors:` YAML block with the following and you'll end up with a facsimile of an old-school green monochrome monitor display (you may need to restart WTF to get changes to take effect). 12 | 13 | ```yaml 14 | colors: 15 | background: "transparent" 16 | border: 17 | focusable: "lightgreen" 18 | focused: "goldenrod" 19 | normal: "darkgreen" 20 | checked: "gray" 21 | highlight: 22 | fore: "black" 23 | back: "green" 24 | labels: "lightgreen::b" 25 | rows: 26 | even: "green" 27 | odd: "lightgreen" 28 | subheading: "lightgreen::b" 29 | text: "green" 30 | title: "lightgreen" 31 | ``` -------------------------------------------------------------------------------- /docs/configuration/advanced.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Multiple Instances of a Widget" 3 | date: 2020-04-26T20:39:16+05:30 4 | draft: false 5 | --- 6 | 7 | # Advanced 8 | 9 | !!! tip 10 | [wtf-tui](https://github.com/ggerganov/wtf-tui) by [@ggerganov](https://github.com/ggerganov) 11 | is a graphical configuration maker for WTFUtil that runs in your terminal. You might find 12 | this easier than configuring YAML by hand. 13 | 14 | ## Multiple Instances of the Same Widget 15 | 16 | To add more than one instance of a particular widget, for example, if you want two Todo widgets, you can do so by adding the `type` property to the entries in your `config.yml` file. Below is an example for Todo: 17 | 18 | ```yaml 19 | home_todo: 20 | checkedIcon: "X" 21 | colors: 22 | checked: gray 23 | highlight: 24 | fore: "black" 25 | back: "orange" 26 | enabled: true 27 | filename: "todo.yml" 28 | position: 29 | top: 0 30 | left: 0 31 | height: 2 32 | width: 2 33 | refreshInterval: 1h 34 | type: todo 35 | ``` 36 | 37 | ```yaml 38 | work_todo: 39 | checkedIcon: "X" 40 | colors: 41 | checked: gray 42 | highlight: 43 | fore: "black" 44 | back: "orange" 45 | enabled: true 46 | filename: "todo.yml" 47 | position: 48 | top: 0 49 | left: 2 50 | height: 2 51 | width: 2 52 | refreshInterval: 1h 53 | type: todo 54 | ``` -------------------------------------------------------------------------------- /docs/configuration/common_settings.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Common Settings" 3 | date: 2019-09-22T18:20:35-07:00 4 | draft: false 5 | weight: 7 6 | --- 7 | 8 | # Common Settings 9 | 10 | The following settings are common to all modules. Common settings have logical defaults and are all optional. An explicitly-defined common setting will over-ride a module's internal default setting value. 11 | 12 | An example with all common settings explicitly configured. 13 | 14 | ```yaml 15 | feedreader: 16 | border: true 17 | enabled: true 18 | feeds: 19 | - https://news.ycombinator.com/rss 20 | feedLimit: 10 21 | focusable: false 22 | focusChar: 2 23 | position: 24 | top: 2 25 | left: 2 26 | width: 1 27 | height: 1 28 | title: "Hacker News" 29 | refreshInterval: 4h 30 | ``` 31 | 32 | ## Attributes 33 | 34 | 35 | --8<-- "attributes/table_header.md" 36 | 37 | 38 | --8<-- "attributes/border.md" 39 | --8<-- "attributes/enabled.md" 40 | --8<-- "attributes/focusable.md" 41 | --8<-- "attributes/focus_char.md" 42 | --8<-- "attributes/position.md" 43 | --8<-- "attributes/refreshInterval.md" 44 | --8<-- "attributes/title.md" 45 | 46 |
-------------------------------------------------------------------------------- /docs/configuration/files.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Configuration" 3 | date: 2018-04-15T21:17:16-07:00 4 | draft: false 5 | weight: 20 6 | alwaysopen: false 7 | --- 8 | 9 | # Configuration Files 10 | 11 | By default WTF looks in a `~/.config/wtf/` directory for a YAML file called 12 | `config.yml`. If the `~/.config/wtf/` directory doesn't exist, WTF will create that directory 13 | on start-up, and then display instructions for creating a new 14 | configuration file. 15 | 16 | In other words, WTF expects to have a YAML config file at: `~/.config/wtf/config.yml`. 17 | 18 | #### Example Configuration Files 19 | 20 | A number of example configuration files are provided in the `_sample_configs/` 21 | directory of the [Git repository](https://github.com/wtfutil/wtf/tree/master/_sample_configs). 22 | 23 | To try out WTF quickly, copy 24 | `sample_config.yml` into `~/.config/wtf/` as `config.yml` and relaunch WTF. You 25 | should see the app launch and display the [Security](/modules/security), 26 | [Clocks](/modules/clocks/) and [Status](/modules/status/) widgets onscreen. 27 | 28 | #### Custom Configuration Files 29 | 30 | To try out different configurations (or run multiple instances of WTF), 31 | you can pass the path to a config file via command line arguments on 32 | start-up. 33 | 34 | To load a custom configuration file (ie: one that's not 35 | `~/.config/wtf/config.yml`), pass in the path to configuration file as a 36 | parameter on launch: 37 | 38 | ```bash 39 | ❯ wtfutil --config=path/to/custom/config.yml 40 | ``` 41 | -------------------------------------------------------------------------------- /docs/configuration/grid_layout.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Grid Layout" 3 | date: 2019-05-05T12:01:04-07:00 4 | draft: false 5 | weight: 10 6 | --- 7 | 8 | # Grid Layout 9 | 10 | WTF uses the `Grid` layout system from [tview](https://github.com/rivo/tview/blob/master/grid.go) to position widgets onscreen. It's not immediately obvious how this works, so here's an explanation: 11 | 12 | Think of your terminal screen as a matrix of letter positions, say `100` chrs wide and `58` chrs tall. 13 | 14 | Columns breaks up the width of the screen into chunks, each chunk a specified number of characters wide. use 15 | 16 | `[10, 10, 10, 10, 10, 10, 10, 10, 10, 10]` 17 | 18 | Ten columns that are ten characters wide 19 | 20 | Rows break up the height of the screen into chunks, each chunk a specified number of characters tall. If we wanted to have five rows: 21 | 22 | `[10, 10, 10, 10, 18]` 23 | 24 | The 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'd position it at: 25 | 26 | ```yaml 27 | top: 4 // top starts in the 4th row 28 | left: 9 // left starts in the 9th column 29 | height: 2 // span down rows 4 & 5 (18 characters in size, total) 30 | width: 2 // span across cols 9 & 10 (20 characters in size, total) 31 | ``` -------------------------------------------------------------------------------- /docs/development/creating_new_modules.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Creating New Modules" 3 | date: 2021-12-12 4 | draft: false 5 | weight: 30 6 | --- 7 | 8 | # Creating New Modules 9 | 10 | The [widgets](../glossary/#widget) that you see on the screen are displayed using [modules](../glossary/#module). To make it easier to create new modules there is a generator which creates a stub (an empty module). The Go package _generators_ contains generator scripts for different types of widgets. 11 | 12 | ## Prerequisites 13 | 14 | Before you can generate new modules, you'll need to have: 15 | 16 | * Go version 1.15 or higher 17 | * The source code for WTF (`git clone https://github.com/wtfutil/wtf`) 18 | 19 | ## Creating a New Text Widget 20 | 21 | 1. Generate a new module using generator 22 | Use `go run generator/textwidget.go` to create a new widget called **NewTextWidget**. You can change the name of the generated widget by setting an environment variable called `WTF_WIDGET_NAME`. 23 | 24 | For example, to generate a new widget called _MyNewWidget_ on macOs or linux, the command would be: 25 | 26 | ```bash 27 | # as a single line 28 | ❯ WTF_WIDGET_NAME=MyNewWidget go run generator/textwidget.go 29 | 30 | # setting the name separately 31 | ❯ export WTF_WIDGET_NAME=MyNewWidget 32 | ❯ go run generator/textwidget.go 33 | ``` 34 | 35 | The equivalent using Windows PowerShell would be 36 | 37 | ```bash 38 | ❯ $env:WTF_WIDGET_NAME = "MyNewWidget" 39 | ❯ go run generator\textwidget.go 40 | ``` 41 | 42 | The new widget is generated using the template in `textwidget.tpl` 43 | 44 | 2. Register your newly generated module in app 45 | 46 | The last step is to register your new module in `app/widget_maker.go`, you will have to import your module and define a new case with your module name. 47 | 48 | 49 | 3. Run you app, your module should be present ! 50 | 51 | 52 | ## Source Code 53 | 54 | ```bash 55 | wtf/generator/ 56 | ``` 57 | -------------------------------------------------------------------------------- /docs/glossary.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Glossary" 3 | date: 2018-04-17T12:34:51-07:00 4 | draft: false 5 | weight: 20 6 | --- 7 | 8 | # Glossary 9 | 10 | ## Module 11 | A discrete unit of data collection and display. A data interface concept. A package inside the app. 12 | 13 | Examples: [New Relic](/modules/newrelic), [Git](/modules/git), [Weather](/modules/weather_services/weather). 14 | 15 | ## Widget 16 | The onscreen representation of a Module. The widget is responsible for 17 | being the interface between the app and the data collection. 18 | 19 | Widgets are defined by a required `widget.go` file in a Module. 20 | 21 | ## WTF 22 | An acronym for "What The Fsck?", as in "What the fsck are all these browser tabs open for?" and "What the fsck am I doing today?" 23 | 24 | (And if you're not a fan of that, then it stands for "What are The Facts?", or "Whiskey Tango Foxtrot", or "Where to, Frodo?". It's up to you.) -------------------------------------------------------------------------------- /docs/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | template: home.html 3 | title: WTF - the terminal dashboard 4 | --- 5 | -------------------------------------------------------------------------------- /docs/installation.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Installation" 3 | date: 2018-05-18T09:59:40-07:00 4 | draft: false 5 | weight: 1 6 | --- 7 | 8 | # Installation 9 | 10 | ## Homebrew 11 | 12 | The easiest way to install from Homebrew is of course 13 | 14 | ```bash 15 | ❯ brew install wtfutil 16 | ``` 17 | 18 | Or, to stay up-to-date with the very latest release at all times, tap the cask that is 19 | generated on each new release: 20 | 21 | ```bash 22 | ❯ brew tap wtfutil/wtfutil 23 | ❯ brew install wtfutil 24 | 25 | ❯ wtfutil 26 | ``` 27 | 28 | ## As a Binary 29 | 30 | Grab the latest version from the Releases page. 31 | 32 | Expand it, and `cd` into the resulting directory. Then run: 33 | 34 | ```bash 35 | ❯ ./wtfutil 36 | ``` 37 | 38 | and that should also do it. 39 | 40 | ## From Source 41 | 42 | Download the source code repo and install the dependencies: 43 | 44 | ```bash 45 | # Set the Go proxy variable to GoCenter 46 | ❯ export GOPROXY="https://gocenter.io" 47 | 48 | # Enable Go modules 49 | ❯ export GO111MODULE=on 50 | 51 | ❯ go get -u github.com/wtfutil/wtf 52 | ❯ cd $GOPATH/src/github.com/wtfutil/wtf 53 | ❯ make install 54 | ❯ make run 55 | ``` 56 | 57 | and that should do it. 58 | 59 | -------------------------------------------------------------------------------- /docs/modules/azure_devops.md: -------------------------------------------------------------------------------- 1 | # Azure Devops 2 | 3 | ## Configuration 4 | 5 | ```yaml 6 | azuredevops: 7 | apiToken: "p0d13*********************************************c3" 8 | enabled: true 9 | labelColor: "lightblue" 10 | maxRows: 3 11 | orgURL: "https://dev.azure.com/myawesomecompany/" 12 | position: 13 | top: 0 14 | left: 0 15 | height: 3 16 | width: 3 17 | projectName: "the awesome project" 18 | refreshInterval: 300 19 | type: "azuredevops" 20 | ``` 21 | 22 | ## Attributes 23 | 24 | 25 | {% include "attributes/table_header.md" %} 26 | 27 | 28 | {% with name="Azure DevOps", envvar="WTF_AZURE_DEVOPS_API_TOKEN" %} 29 | {% include "attributes/apikey.md" %} 30 | {% endwith %} 31 | 32 | 33 | 39 | 40 | 41 | 42 | 47 | 48 | 49 | 50 | 55 | 56 | 57 | 58 | 63 | 64 | 65 | 66 |
34 | labelColor 35 |
36 | Optional The color of the title label. Default: white. 37 | 38 | 		Any X11 color name.
43 | maxRows 44 |
45 | Optional The maximum number of rows to display. Default: 3. 46 | 		Any positive integer.
51 | orgURL 52 |
53 | The URL to your Azure DevOps project. 54 | 		Leave empty to use the WTF_AZURE_DEVOPS_ORG_URL environment variable.
59 | projectName 60 |
61 | The name of your Azure DevOps project. 62 | 		Leave empty to use the WTF_AZURE_DEVOPS_PROJECT_NAME environment variable.
67 | 68 | {% set src="azuredevops" %} 69 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/bamboohr.md: -------------------------------------------------------------------------------- 1 | # BambooHR 2 | 3 | ## Configuration 4 | 5 | ```yaml 6 | bamboohr: 7 | apiKey: "p0d13*********************************************c3" 8 | enabled: true 9 | position: 10 | top: 0 11 | left: 1 12 | height: 2 13 | width: 1 14 | refreshInterval: 15m 15 | subdomain: "testco" 16 | ``` 17 | 18 | ## Attributes 19 | 20 | 21 | {% include "attributes/table_header.md" %} 22 | 23 | 24 | {% with name="BambooHR", envvar="WTF_BAMBOO_HR_TOKEN" %} 25 | {% include "attributes/apikey.md" %} 26 | {% endwith %} 27 | 28 | 29 | 34 | 35 | 36 | 37 |
30 | subdomain 31 |
32 | Your BambooHR API subdomain name. Leave this blank to use the WTF_BAMBOO_HR_SUBDOMAIN environment variable. 33 |
38 | 39 | {% set src="bamboohr" %} 40 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/bargraph.md: -------------------------------------------------------------------------------- 1 | # Bargraph 2 | 3 | Demo bar graph with dummy data. 4 | 5 | ## Configuration 6 | 7 | ```yaml 8 | spotify: 9 | enabled: true 10 | colors: 11 | label: "green" 12 | text: "white" 13 | position: 14 | top: 1 15 | left: 2 16 | height: 1 17 | width: 1 18 | refreshInterval: 0 19 | ``` 20 | 21 | ## Screenshots 22 | 23 | baargraph screenshot 24 | 25 | {% set src="bargraph" %} 26 | {% include "src_path.md" %} 27 | -------------------------------------------------------------------------------- /docs/modules/buildkite.md: -------------------------------------------------------------------------------- 1 | # Buildkite 2 | 3 | Connects to the [Buildkite](https://buildkite.com) REST API and displays status of branches for configured Pipelines. 4 | 5 | The API token must have the `read_builds` permission. 6 | 7 | ## Configuration 8 | 9 | ```yaml 10 | buildkite: 11 | apiKey: "p0d13*********************************************c3" 12 | enabled: true 13 | organizationSlug: "acme-corp" 14 | refreshInterval: 1m 15 | position: 16 | top: 1 17 | left: 1 18 | height: 1 19 | width: 1 20 | pipelines: 21 | pipeline-slug-1: 22 | branches: 23 | - "master" 24 | - "stage" 25 | pipeline-slug-2: 26 | branches: 27 | - "master" 28 | - "production" 29 | ``` 30 | 31 | ## Attributes 32 | 33 | 34 | {% include "attributes/table_header.md" %} 35 | 36 | 37 | {% with name="Buildkite", envvar="WTF_BUILDKITE_TOKEN" %} 38 | {% include "attributes/apikey.md" %} 39 | {% endwith %} 40 | 41 | 42 | 47 | 48 | 49 | 50 | 55 | 56 | 57 | 58 | 59 |
43 | organizationSlug 44 |
45 | The slug of your organization 46 | 		org.slug
51 | pipelines 52 |
53 | A hash with pipeline.slug as keys, mapping to a list of branches. 54 |
60 | 61 | {% set src="buildkite" %} 62 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/cds/favorites.md: -------------------------------------------------------------------------------- 1 | # CDS Favorites 2 | 3 | Display runs of you [CDS](https://ovh.github.io/cds/) favorites workflows. 4 | 5 | ## Configuration 6 | 7 | ```yaml 8 | cdsFavorites: 9 | enabled: true 10 | position: 11 | top: 0 12 | left: 0 13 | height: 2 14 | width: 2 15 | refreshInterval: 8s 16 | apiURL: https://api.cds.localhost.local 17 | token: xxxxxxxxxxxx 18 | hideTags: 19 | - "git.repository" 20 | - "git.hash" 21 | - "triggered_by" 22 | ``` 23 | 24 | ## Screenshots 25 | 26 | CDS Favorites screenshot 27 | 28 | ## Attributes 29 | 30 | 31 | {% include "attributes/table_header.md" %} 32 | 33 | 34 | 35 | 40 | 41 | 42 | 43 | 48 | 49 | 50 | 51 | 56 | 57 | 58 | 59 |
36 | apiURL 37 |
38 | Your CDS API URL. 39 |
44 | token 45 |
46 | Your CDS Consumer Token. 47 |
52 | hideTags 53 |
54 | A CDS Runs can have many "cds tags". You can hide some tags displayed. 55 |
60 | 61 | {% set src="cds/favorites/" %} 62 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/cds/queue.md: -------------------------------------------------------------------------------- 1 | # CDS Queue 2 | 3 | Display current [CDS](https://ovh.github.io/cds/) queue - waiting or building jobs. 4 | 5 | ## Configuration 6 | 7 | ```yaml 8 | cdsQueue: 9 | enabled: true 10 | position: 11 | top: 0 12 | left: 0 13 | height: 3 14 | width: 2 15 | refreshInterval: 8s 16 | apiURL: https://api.cds.localhost.local 17 | token: xxxxxxxxxxxx 18 | ``` 19 | 20 | ## Screenshots 21 | 22 | CDS Queue screenshot 23 | 24 | ## Attributes 25 | 26 | 27 | {% include "attributes/table_header.md" %} 28 | 29 | 30 | 31 | 36 | 37 | 38 | 39 | 44 | 45 | 46 | 47 |
32 | apiURL 33 |
34 | Your CDS API URL. 35 |
40 | token 41 |
42 | Your CDS Consumer Token. 43 |
48 | 49 | {% set src="cds/queue/" %} 50 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/cds/status.md: -------------------------------------------------------------------------------- 1 | # CDS Status 2 | 3 | Display current [CDS](https://ovh.github.io/cds/) status. This is useful for CDS Administrator only. 4 | 5 | ## Configuration 6 | 7 | ```yaml 8 | cdsStatus: 9 | enabled: true 10 | position: 11 | top: 0 12 | left: 0 13 | height: 3 14 | width: 2 15 | refreshInterval: 8s 16 | apiURL: https://api.cds.localhost.local 17 | token: xxxxxxxxxxxx 18 | ``` 19 | 20 | ## Screenshots 21 | 22 | CDS Status screenshot 23 | 24 | ## Attributes 25 | 26 | 27 | {% include "attributes/table_header.md" %} 28 | 29 | 30 | 31 | 36 | 37 | 38 | 39 | 44 | 45 | 46 | 47 |
32 | apiURL 33 |
34 | Your CDS API URL. 35 |
40 | token 41 |
42 | Your CDS Consumer Token. 43 |
48 | 49 | {% set src="cds/status/" %} 50 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/circleci.md: -------------------------------------------------------------------------------- 1 | # CircleCI 2 | 3 | Displays build information for your CircleCI account. 4 | 5 | ## Configuration 6 | 7 | ```yaml 8 | circleci: 9 | apiKey: "p0d13*********************************************c3" 10 | enabled: true 11 | position: 12 | top: 4 13 | left: 1 14 | height: 1 15 | width: 2 16 | refreshInterval: 15m 17 | ``` 18 | 19 | ## Screenshots 20 | 21 | circleci screenshot 22 | 23 | ## Attributes 24 | 25 | 26 | {% include "attributes/table_header.md" %} 27 | 28 | 29 | {% with name="CircleCI", envvar="WTF_CIRCLE_API_KEY" %} 30 | {% include "attributes/apikey.md" %} 31 | {% endwith %} 32 | 33 | 34 | 35 |
36 | 37 | {% set src="circleci" %} 38 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/covid.md: -------------------------------------------------------------------------------- 1 | # COVID 2 | 3 | Provides details about COVID-19 cases and deaths. 4 | 5 | ## Configuration 6 | 7 | ```yaml 8 | covid: 9 | enabled: true 10 | colors: 11 | label: "green" 12 | text: "white" 13 | countries: 14 | - AD 15 | - AE 16 | - AF 17 | position: 18 | top: 1 19 | left: 2 20 | height: 2 21 | width: 2 22 | refreshInterval: 1h 23 | ``` 24 | 25 | ## Attributes 26 | 27 | 28 | {% include "attributes/table_header.md" %} 29 | 30 | 31 | 32 | 37 | 38 | 39 | 40 |
33 | countries 34 |
35 | The list of country codes (ISO 3166-1 alpha-2) to display detailed information for. 36 |
41 | 42 | ## Screenshots 43 | 44 | covid screenshot 45 | 46 | {% set src="covid" %} 47 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/cryptocurrencies/blockfolio.md: -------------------------------------------------------------------------------- 1 | # Blockfolio 2 | 3 | Display your Blockfolio crypto holdings. 4 | 5 | ## Configuration 6 | 7 | ```yaml 8 | blockfolio: 9 | colors: 10 | name: blue 11 | grows: green 12 | drop: red 13 | device_token: "device token" 14 | displayHoldings: true 15 | enabled: true 16 | position: 17 | top: 3 18 | left: 1 19 | width: 1 20 | height: 1 21 | refreshInterval: 400s 22 | ``` 23 | 24 | ## Screenshots 25 | 26 | blockfolio screenshot 27 | 28 | ## Attributes 29 | 30 | 31 | {% include "attributes/table_header.md" %} 32 | 33 | 34 | 35 | 39 | 41 | 42 | 43 | 47 | 49 | 50 | 51 | 55 | 57 | 58 | 59 | 64 | 65 | 66 | 67 |
36 | colors.drop 37 |
38 | 		Any X11 color name or long-form hex value (i.e.: 40 | #ff0000).
44 | colors.grows 45 |
46 | 		Any X11 color name or long-form hex value (i.e.: 48 | #ff0000).
52 | colors.name 53 |
54 | 		Any X11 color name or long-form hex value (i.e.: 56 | #ff0000).
60 | device_token 61 |
62 | See this gist for details on how to get your Blockfolio API token. 63 |
68 | 69 | {% set src="cryptoexchanges/blockfolio" %} 70 | {% include "src_path.md" %} 71 | -------------------------------------------------------------------------------- /docs/modules/cryptocurrencies/mempool.md: -------------------------------------------------------------------------------- 1 | # Mempool 2 | 3 | Get the current sat/vB prices to use for Bitcoin transactions using [Mempool](https://mempool.space/). 4 | 5 | ## Configuration 6 | 7 | ### Without borders 8 | `width` x `height`: 18 chars x 4 chars 9 | 10 | ### With borders 11 | 20 chars x 6 chars 12 | 13 | ```yaml 14 | mempool: 15 | enabled: true 16 | border: false 17 | position: 18 | top: 1 19 | left: 0 20 | width: 9 21 | height: 4 22 | refreshInterval: 120 23 | ``` 24 | 25 | ## Screenshots 26 | 27 | mempool screenshot 28 | 29 | {% set src="cryptoexchanges/mempool" %} 30 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/datadog.md: -------------------------------------------------------------------------------- 1 | # Datadog 2 | 3 | Connects to the Datadog API and displays alerting modules. 4 | 5 | ## Configuration 6 | 7 | ```yaml 8 | datadog: 9 | apiKey: "" 10 | applicationKey: "" 11 | enabled: true 12 | monitors: 13 | tags: 14 | - "team:ops" 15 | position: 16 | top: 4 17 | left: 3 18 | height: 1 19 | width: 2 20 | ``` 21 | 22 | ## Attributes 23 | 24 | 25 | {% include "attributes/table_header.md" %} 26 | 27 | 28 | {% with name="Datadog", envvar="WTF_DATADOG_API_KEY" %} 29 | {% include "attributes/apikey.md" %} 30 | {% endwith %} 31 | 32 | 33 | 38 | 39 | 40 | 41 | 46 | 47 | 48 | 49 | 54 | 55 | 56 |
34 | applicationKey 35 |
36 | Your DataDog application key. Leave this empty to use the WTF_DATADOG_APPLICATION_KEY environment variable. 37 |
42 | monitors 43 |
44 | Configuration for the monitors functionality. 45 |
50 | tags 51 |
52 | List of tags you want to query monitors by. 53 |
57 | 58 | {% set src="datadog" %} 59 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/devto.md: -------------------------------------------------------------------------------- 1 | # DEV 2 | 3 | Displays stories from [The Practical DEV](https://dev.to). 4 | 5 | ## Configuration 6 | 7 | ```yaml 8 | devto: 9 | enabled: true 10 | numberOfArticles: 10 11 | position: 12 | top: 1 13 | left: 1 14 | height: 1 15 | width: 2 16 | contentTag: "showdev" 17 | contentUsername: "victoravelar" 18 | contentState: "rising" 19 | ``` 20 | 21 | ## Attributes 22 | 23 | 24 | {% include "attributes/table_header.md" %} 25 | 26 | 27 | 28 | 33 | 34 | 35 | 36 | 41 | 42 | 43 | 44 | 49 | 50 | 51 | 52 | 57 | 58 | 59 | 60 |
29 | contentTag 30 |
31 | Optional List articles from a specific tag. 32 |
37 | contentUsername 38 |
39 | Optional List articles from a specific user. 40 |
45 | contentState 46 |
47 | Optional Alters the feed output. 48 |
53 | numberOfArticles 54 |
55 | Optional Defines number of articles to be displayed. Default: 10. 56 | 		Any positive integer < 20.
61 | 62 | ## Keyboard 63 | 64 | 65 | {% include "keyboard/table_header.md" %} 66 | 67 | 68 | {% include "keyboard/foreslash.md" %} 69 | 70 | {% set esc="Cancel the selection" %} 71 | {% include "keyboard/esc.md" %} 72 | 73 | {% set return="Open the selected story in the browser" %} 74 | {% include "keyboard/return.md" %} 75 | 76 | {% include "keyboard/spacer.md" %} 77 | 78 | {% include "keyboard/arrowDown.md" %} 79 | {% include "keyboard/arrowUp.md" %} 80 | 81 |
82 | 83 | {% set src="devto" %} 84 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/docker.md: -------------------------------------------------------------------------------- 1 | docker 2 | 3 | # Docker 4 | 5 | Displays information about currently-running Docker processes. 6 | 7 | ## Configuration 8 | 9 | ```yaml 10 | docker: 11 | type: docker 12 | enabled: true 13 | labelColor: lightblue 14 | position: 15 | top: 0 16 | left: 0 17 | height: 3 18 | width: 3 19 | refreshInterval: 1s 20 | ``` 21 | 22 | ## Screenshots 23 | 24 | github screenshot 25 | 26 | ## Attributes 27 | 28 | 29 | {% include "attributes/table_header.md" %} 30 | 31 | 32 | 33 | 38 | 39 | 40 | 41 |
34 | labelColor 35 |
36 | The color to display the row labels in. 37 |
42 | 43 | {% set src="docker" %} 44 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/feedreader.md: -------------------------------------------------------------------------------- 1 | # Feed Reader 2 | 3 | An RSS & Atom feed reader. 4 | 5 | ## Configuration 6 | 7 | ```yaml 8 | feedreader: 9 | enabled: true 10 | feeds: 11 | - https://news.ycombinator.com/rss 12 | - https://rss.cbc.ca/lineup/topstories.xml 13 | feedLimit: 10 14 | position: 15 | top: 4 16 | left: 1 17 | height: 1 18 | width: 2 19 | refreshInterval: 4h 20 | ``` 21 | 22 | ## Screenshots 23 | 24 | feedreader screenshot 25 | 26 | ## Attributes 27 | 28 | 29 | {% include "attributes/table_header.md" %} 30 | 31 | 32 | 33 | 38 | 39 | 40 | 41 | 46 | 47 | 48 | 49 |
34 | feedLimit 35 |
36 | The number of stories from each feed to be displayed. Default is -1, which will display all available stories. 37 |
42 | feeds 43 |
44 | List of RSS or Atom feed URLs. 45 |
50 | 51 | ## Keyboard 52 | 53 | 54 | {% include "keyboard/table_header.md" %} 55 | 56 | 57 | {% include "keyboard/foreslash.md" %} 58 | 59 | {% set return="Open the selected story in the browser" %} 60 | {% include "keyboard/return.md" %} 61 | 62 | {% include "keyboard/spacer.md" %} 63 | 64 | {% include "keyboard/j.md" %} 65 | {% include "keyboard/k.md" %} 66 | 67 | {% set o="Open the selected story in the browser" %} 68 | {% include "keyboard/o.md" %} 69 | 70 | {% include "keyboard/r.md" %} 71 | 72 | {% set t="Switches the display mode between `title`, `link`, and `title and content`" %} 73 | {% include "keyboard/t.md" %} 74 | 75 | {% include "keyboard/spacer.md" %} 76 | 77 | {% include "keyboard/arrowDown.md" %} 78 | {% include "keyboard/arrowUp.md" %} 79 | 80 | 81 |
82 | 83 | 84 | {% set src="feedreader" %} 85 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/gitlabtodo.md: -------------------------------------------------------------------------------- 1 | # GitLab Todo 2 | 3 | View your GitLab Todos. 4 | 5 | ## Configuration 6 | 7 | ```yaml 8 | gitlabtodo: 9 | apiKey: "dexxxxxxxxxxxxxxxxxxxxxxxxxx34" 10 | domain: "example.com" 11 | enabled: true 12 | numberOfTodos: 12, 13 | position: 14 | top: 2 15 | left: 3 16 | height: 2 17 | width: 2 18 | refreshInterval: 5m 19 | showProject: true 20 | ``` 21 | 22 | ## Attributes 23 | 24 | 25 | {% include "attributes/table_header.md" %} 26 | 27 | 28 | {% with name="GitLab", envvar="WTF_GITLAB_API_KEY" %} 29 | {% include "attributes/apikey.md" %} 30 | {% endwith %} 31 | 32 | {% with name="domain", desc="Your GitLab corporate domain.", value="" %} 33 | {% include "attributes/custom.md" %} 34 | {% endwith %} 35 | 36 | {% with name="numberOfTodos", desc="Optional Defines number of stories to be displayed. Default is 10.", value="" %} 37 | {% include "attributes/custom.md" %} 38 | {% endwith %} 39 | 40 | {% with name="showProject", desc="Optional Determines whether or not to show the project a given todo is for. Default: true.", value="true, false." %} 41 | {% include "attributes/custom.md" %} 42 | {% endwith %} 43 | 44 |
45 | 46 | {% set src="gitlabtodo" %} 47 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/gitter.md: -------------------------------------------------------------------------------- 1 | # Gitter 2 | 3 | Displays chat messages from Gitter. 4 | 5 | ## Configuration 6 | 7 | ```yaml 8 | gitter: 9 | apiToken: "d23*******************************************3r2" 10 | enabled: true 11 | numberOfMessages: 10 12 | position: 13 | top: 4 14 | left: 1 15 | height: 1 16 | width: 4 17 | roomUri: wtfutil/Lobby 18 | refreshInterval: 5m 19 | ``` 20 | 21 | ## Screenshots 22 | 23 | gitter screenshot 24 | 25 | ## Attributes 26 | 27 | 28 | {% include "attributes/table_header.md" %} 29 | 30 | 31 | {% with name="Gitter", envvar="WTF_GITTER_API_TOKEN" %} 32 | {% include "attributes/apikey.md" %} 33 | {% endwith %} 34 | 35 | {% with name="numberOfMessages", desc="Optional Maximum number of new messages to be displayed. Default is 10.", value="" %} 36 | {% include "attributes/custom.md" %} 37 | {% endwith %} 38 | 39 | {% with name="roomURI", desc="Optional URI of the room you would like to see the chat messages for. Default is wtfutil/Lobby", value="" %} 40 | {% include "attributes/custom.md" %} 41 | {% endwith %} 42 | 43 |
44 | 45 | ## Keyboard 46 | 47 | 48 | {% include "keyboard/table_header.md" %} 49 | 50 | 51 | {% include "keyboard/foreslash.md" %} 52 | 53 | {% include "keyboard/spacer.md" %} 54 | 55 | {% include "keyboard/j.md" %} 56 | {% include "keyboard/k.md" %} 57 | {% include "keyboard/r.md" %} 58 | 59 | {% include "keyboard/spacer.md" %} 60 | 61 | {% include "keyboard/arrowDown.md" %} 62 | {% include "keyboard/arrowUp.md" %} 63 |
64 | 65 | {% set src="gitter" %} 66 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/google/spreadsheet.md: -------------------------------------------------------------------------------- 1 | # Google Spreadsheet 2 | 3 | Display information from cells in a Google Spreadsheet. 4 | 5 | ## Configuration 6 | 7 | ```yaml 8 | gspreadsheets: 9 | colors: 10 | values: "green" 11 | cells: 12 | names: 13 | - "Cell 1 name" 14 | - "Cell 2 name" 15 | addresses: 16 | - "A1" 17 | - "A2" 18 | enabled: true 19 | position: 20 | top: 0 21 | left: 0 22 | width: 1 23 | height: 1 24 | refreshInterval: "5m" 25 | secretFile: "~/.config/wtf/gspreadsheets/client_secret.json" 26 | sheetId: "id_of_google_spreadsheet" 27 | ``` 28 | 29 | ## Attributes 30 | 31 | 32 | {% include "attributes/table_header.md" %} 33 | 34 | 35 | {% with name="colors.values", desc="Optional The color to display the cell values in." %} 36 | {% include "attributes/colors/custom.md" %} 37 | {% endwith %} 38 | 39 | {% with name="colors.names", desc="Optional" %} 40 | {% include "attributes/colors/custom.md" %} 41 | {% endwith %} 42 | 43 | {% with name="colors.addresses", desc="Optional" %} 44 | {% include "attributes/colors/custom.md" %} 45 | {% endwith %} 46 | 47 | {% with name="secretFile", desc="Your Google client secret JSON file.", value="A string representing a file path to the JSON secret file." %} 48 | {% include "attributes/custom.md" %} 49 | {% endwith %} 50 | 51 |
52 | 53 | {% set src="gspreadsheets" %} 54 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/hackernews.md: -------------------------------------------------------------------------------- 1 | # HackerNews 2 | 3 | Displays stories from Hacker News. 4 | 5 | ## Configuration 6 | 7 | ```yaml 8 | hackernews: 9 | enabled: true 10 | numberOfStories: 10 11 | position: 12 | top: 4 13 | left: 1 14 | height: 1 15 | width: 2 16 | storyType: top 17 | refreshInterval: 15m 18 | ``` 19 | 20 | ## Screenshots 21 | 22 | hackernews screenshot 23 | 24 | ## Attributes 25 | 26 | 27 | {% include "attributes/table_header.md" %} 28 | 29 | 30 | {% with name="numberOfStories", desc="Optional Defines number of stories to be displayed. Default: 10.", value="Any positive integer." %} 31 | {% include "attributes/custom.md" %} 32 | {% endwith %} 33 | 34 | {% with name="storyType", desc="Optional Defines type of stories to be displayed. Default: top.", value="new, top, job, ask" %} 35 | {% include "attributes/custom.md" %} 36 | {% endwith %} 37 | 38 |
39 | 40 | ## Keyboard 41 | 42 | ## Keyboard 43 | 44 | 45 | {% include "keyboard/table_header.md" %} 46 | 47 | 48 | {% include "keyboard/foreslash.md" %} 49 | 50 | {% set return="Open the selected story in the browser" %} 51 | 52 | {% include "keyboard/spacer.md" %} 53 | 54 | {% set c="Open the selected story's comments in the browser" %} 55 | {% include "keyboard/c.md" %} 56 | 57 | {% include "keyboard/j.md" %} 58 | {% include "keyboard/k.md" %} 59 | 60 | {% set o="Open the selected story in the browser" %} 61 | {% include "keyboard/o.md" %} 62 | 63 | {% include "keyboard/r.md" %} 64 | 65 | {% include "keyboard/spacer.md" %} 66 | 67 | {% include "keyboard/arrowDown.md" %} 68 | {% include "keyboard/arrowUp.md" %} 69 | 70 |
71 | 72 | {% set src="hackernews" %} 73 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/healthchecks.md: -------------------------------------------------------------------------------- 1 | # Healthchecks 2 | 3 | Connect to the [Healthchecks](https://healthchecks.io) API. 4 | 5 | ## Configuration 6 | 7 | ```yaml 8 | healthchecks: 9 | type: healthchecks 10 | enabled: true 11 | apiKey: "XXXX" 12 | apiURL: "https://healthchecks.io/" 13 | tags: 14 | - backup 15 | position: 16 | top: 0 17 | left: 1 18 | height: 2 19 | width: 1 20 | ``` 21 | 22 | ## Screenshots 23 | 24 | Healthchecks screenshot 25 | 26 | 27 | ## Attributes 28 | 29 | 30 | {% include "attributes/table_header.md" %} 31 | 32 | 33 | {% with name="Healthchecks", envvar="WTF_HEALTHCHECKS_APIKEY" %} 34 | {% include "attributes/apikey.md" %} 35 | {% endwith %} 36 | 37 | {% with name="apiKey", desc="Healthchecks read-only API-key", value="string" %} 38 | {% include "attributes/custom.md" %} 39 | {% endwith %} 40 | 41 | {% with name="apiURL", desc="Optional Healthchecks API URL. Default: https://healthchecks.io/", value="string" %} 42 | {% include "attributes/custom.md" %} 43 | {% endwith %} 44 | 45 | {% with name="tags", desc="Only show checks with tags", value="list" %} 46 | {% include "attributes/custom.md" %} 47 | {% endwith %} 48 | 49 |
50 | 51 | {% set src="healthchecks" %} 52 | {% include "src_path.md" %} 53 | -------------------------------------------------------------------------------- /docs/modules/hibp.md: -------------------------------------------------------------------------------- 1 | # Have I Been Pwned (HIBP) 2 | 3 | Indicates whether or not your listed email addresses appear in the [Have I Been Pwned](https://haveibeenpwned.com) breach database. 4 | 5 | **Note:** As of v0.19.0, WTF requires you use a Have I Been Pwned API key to connect to the service. See details below. 6 | 7 | ## Configuration 8 | 9 | ```yaml 10 | hibp: 11 | accounts: 12 | - test@example.com 13 | - pwned@gmail.com 14 | apiKey: "p0d13*********************************************c3" 15 | colors: 16 | ok: "green" 17 | pwned: "red" 18 | enabled: true 19 | position: 20 | top: 4 21 | left: 1 22 | height: 1 23 | width: 2 24 | refreshInterval: 12h 25 | since: "2019-06-22" 26 | ``` 27 | 28 | ## Screenshots 29 | 30 | hibp screenshot 31 | 32 | ## Attributes 33 | 34 | 35 | {% include "attributes/table_header.md" %} 36 | 37 | 38 | {% with name="accounts", desc="A list of the accounts to check the HIBP database for." %} 39 | {% include "attributes/custom.md" %} 40 | {% endwith %} 41 | 42 | {% with name="DigitalOcean", envvar="WTF_DIGITALOCEAN_API_KEY" %} 43 | {% include "attributes/apikey.md" %} 44 | {% endwith %} 45 | 46 | {% with name="colors", desc="Optional The colors to display for accounts that have not been pwned and ones that have. Defaults to white for unpwned accounts, red for pwned accounts." %} 47 | {% include "attributes/custom.md" %} 48 | {% endwith %} 49 | 50 | {% with name="since", desc="Optional Only check for breaches after this date. Set this if you've been breached in the past, have taken steps to mitigate that (changing passwords, cancelling accounts, etc.) and only want to know about future breaches.", value="A date string in the format 'yyyy-mm-dd', ie: '2019-06-22'" %} 51 | {% include "attributes/custom.md" %} 52 | {% endwith %} 53 | 54 |
55 | 56 | {% set src="hibp" %} 57 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/index.md: -------------------------------------------------------------------------------- 1 | # Modules 2 | 3 | ![screenshot](/assets/screenshot.png) 4 | 5 | A module is a discrete unit of 6 | functionality that extracts data from a source and packages that data 7 | for display. 8 | 9 | For example, the [New Relic](/modules/newrelic) module 10 | uses New Relic's API to retrieve a list of the latest deploys and 11 | packages that information as a list for display in the "New Relic" 12 | widget. 13 | 14 | The [Clocks](/modules/clocks) module takes a list of 15 | timezones and packages that information as a list of city/time pairs for 16 | display in the "Clocks" widget. 17 | 18 | See left for all available modules. -------------------------------------------------------------------------------- /docs/modules/ipaddress/ipinfo.md: -------------------------------------------------------------------------------- 1 | # IP Info 2 | 3 | Displays your current IP address information, from ipinfo.io. 4 | 5 | **Note:** IPInfo.io has a free-plan rate limit of 1000 requests per day. 6 | 7 | ## Configuration 8 | 9 | ```yaml 10 | ipinfo: 11 | colors: 12 | name: red 13 | value: white 14 | enabled: true 15 | position: 16 | top: 1 17 | left: 2 18 | height: 1 19 | width: 1 20 | refreshInterval: 150s 21 | ``` 22 | 23 | ## Screenshots 24 | 25 | ipinfo screenshot 26 | 27 | ## Attributes 28 | 29 | 30 | {% include "attributes/table_header.md" %} 31 | 32 | 33 | {% with name="colors.name", desc="Optional The default colour for the row names." %} 34 | {% include "attributes/colors/custom.md" %} 35 | {% endwith %} 36 | 37 | {% with name="colors.value", desc="Optional The default colour for the row values." %} 38 | {% include "attributes/colors/custom.md" %} 39 | {% endwith %} 40 | 41 | 46 | 49 | 50 | 51 |
42 | apiToken 43 |
44 | Optional 45 | 		47 | API token for ipinfo.io. 48 |
52 | 53 | {% set src="ipaddresses/ipinfo" %} 54 | {% include "src_path.md" %} 55 | -------------------------------------------------------------------------------- /docs/modules/kubernetes.md: -------------------------------------------------------------------------------- 1 | # Kubernetes 2 | 3 | Displays information about a Kubernetes cluster. 4 | 5 | ## Configuration 6 | 7 | ```yaml 8 | kubernetes: 9 | enabled: true 10 | kubeconfig: "/Users/testuser/.kube/config" 11 | namespaces: 12 | - internal 13 | - public 14 | - systems 15 | objects: 16 | - deployments 17 | - nodes 18 | - pods 19 | position: 20 | top: 4 21 | left: 1 22 | height: 1 23 | width: 2 24 | refreshInterval: 5m 25 | title: "Build System" 26 | ``` 27 | 28 | ## Attributes 29 | 30 | 31 | {% include "attributes/table_header.md" %} 32 | 33 | 34 | {% with name="context", desc="The Kubernetes context to use. If blank, it uses the default context." %} 35 | {% include "attributes/custom.md" %} 36 | {% endwith %} 37 | 38 | {% with name="kubeconfig", desc="The absolute path to your Kubernetes config file." %} 39 | {% include "attributes/custom.md" %} 40 | {% endwith %} 41 | 42 | {% with name="namespaces", desc="A list of namespaces to monitor. Defaults to all if empty." %} 43 | {% include "attributes/custom.md" %} 44 | {% endwith %} 45 | 46 | {% with name="objects", desc="A list of Kubernetes objects to display.", value="Any of nodes, pods, and/or deployments." %} 47 | {% include "attributes/custom.md" %} 48 | {% endwith %} 49 | 50 |
51 | 52 | {% set src="kubernetes" %} 53 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/logger.md: -------------------------------------------------------------------------------- 1 | # Logger 2 | 3 | View contents of wtf log file (~/.config/wtf/log.txt). 4 | 5 | ## Configuration 6 | 7 | ```yaml 8 | logger: 9 | enabled: true 10 | colors: 11 | label: "green" 12 | text: "white" 13 | position: 14 | top: 1 15 | left: 2 16 | height: 1 17 | width: 2 18 | refreshInterval: 15 19 | ``` 20 | 21 | ## Screenshots 22 | 23 | logger screenshot 24 | 25 | {% set src="logger" %} 26 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/lunarphase.md: -------------------------------------------------------------------------------- 1 | # Lunar Phase 2 | 3 | Displays the phase of the Moon as ASCII art from [Wttr.in](http://wttr.in). The width of the column in which the lunar phase is displayed needs to be large enough for the ASCII graphic to fit or multiple columns must be allocated. 4 | 5 | ## Configuration 6 | 7 | ```yaml 8 | lunarphase: 9 | enabled: true 10 | position: 11 | top: 3 12 | left: 5 13 | height: 2 14 | width: 2 15 | language: 'en' 16 | refreshInterval: 5h 17 | ``` 18 | 19 | ## Screenshots 20 | 21 |

22 | lunarphase screenshot 23 | lunarphase french screenshot 24 |

25 | 26 | {% set src="lunarphase" %} 27 | {% include "src_path.md" %} 28 | -------------------------------------------------------------------------------- /docs/modules/newrelic.md: -------------------------------------------------------------------------------- 1 | # New Relic 2 | 3 | Connects to the New Relic API and displays the last n deploys of the 4 | monitored applications: deploy ID, deploy time, and who deployed it. 5 | 6 | ## Configuration 7 | 8 | ```yaml 9 | newrelic: 10 | apiKey: "p0d13*********************************************c3" 11 | applicationIDs: 12 | - 10549735 13 | - 499785 14 | deployCount: 6 15 | enabled: true 16 | position: 17 | top: 4 18 | left: 3 19 | height: 1 20 | width: 2 21 | refreshInterval: 15m 22 | ``` 23 | 24 | ## Screenshots 25 | 26 | newrelic screenshot 27 | 28 | ## Attributes 29 | 30 | 31 | {% include "attributes/table_header.md" %} 32 | 33 | 34 | {% with name="New Relic", envvar="WTF_NEW_RELIC_API_KEY" %} 35 | {% include "attributes/apikey.md" %} 36 | {% endwith %} 37 | 38 | {% with name="applicationIds", desc="A list of integer IDs of the New Relic applications you wish to report on.", value="Any positive integer." %} 39 | {% include "attributes/custom.md" %} 40 | {% endwith %} 41 | 42 | {% with name="deployCount", desc="Optional The number of past deploys to display on screen. Default: 5.", value="Any positive integer." %} 43 | {% include "attributes/custom.md" %} 44 | {% endwith %} 45 | 46 |
47 | 48 | ## Keyboard 49 | 50 | 51 | {% include "keyboard/table_header.md" %} 52 | 53 | 54 | {% include "keyboard/foreslash.md" %} 55 | 56 | {% include "keyboard/spacer.md" %} 57 | 58 | {% set arrowBack="Show the previous application" %} 59 | {% include "keyboard/arrowBack.md" %} 60 | 61 | {% set arrowFore="Show the next application" %} 62 | {% include "keyboard/arrowFore.md" %} 63 | 64 |
65 | 66 | {% set src="newrelic" %} 67 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/opsgenie.md: -------------------------------------------------------------------------------- 1 | # OpsGenie 2 | 3 | Shows OpsGenie on-call schedules. 4 | 5 | See Who is on Call API for details. 6 | 7 | ## Configuration 8 | 9 | ### Single Schedule 10 | 11 | ```yaml 12 | opsgenie: 13 | apiKey: "p0d13*********************************************c3" 14 | displayEmpty: false 15 | enabled: true 16 | position: 17 | top: 2 18 | left: 1 19 | height: 2 20 | width: 1 21 | refreshInterval: 6h 22 | region: "us" 23 | schedule: "Primary" 24 | scheduleIdentifierType: "id" 25 | ``` 26 | 27 | ### Multiple Schedules 28 | 29 | ```yaml 30 | opsgenie: 31 | apiKey: "p0d13*********************************************c3" 32 | displayEmpty: false 33 | enabled: true 34 | position: 35 | top: 2 36 | left: 1 37 | height: 2 38 | width: 1 39 | refreshInterval: 6h 40 | region: "us" 41 | schedule: 42 | - "Primary" 43 | - "Secondary" 44 | scheduleIdentifierType: "id" 45 | ``` 46 | 47 | ## Screenshots 48 | 49 | opsgenie screenshot 50 | 51 | ## Attributes 52 | 53 | 54 | {% include "attributes/table_header.md" %} 55 | 56 | 57 | {% with name="OpsGenie", envvar="WTF_OPS_GENIE_API_KEY" %} 58 | {% include "attributes/apikey.md" %} 59 | {% endwith %} 60 | 61 | {% with name="displayEmpty", desc="Whether schedules with no assigned person on-call should be displayed. Default: true.", value="true, false" %} 62 | {% include "attributes/custom.md" %} 63 | {% endwith %} 64 | 65 | {% with name="region", desc="The region of the servers to connect to.", value="eu, us" %} 66 | {% include "attributes/custom.md" %} 67 | {% endwith %} 68 | 69 | {% with name="scheduleIdentifierType", desc="Type of the schedule identifier.", value="id, name" %} 70 | {% include "attributes/custom.md" %} 71 | {% endwith %} 72 | 73 | 74 |
75 | 76 | {% set src="opsgenie" %} 77 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/pocket.md: -------------------------------------------------------------------------------- 1 | # Pocket 2 | 3 | Displays Pocket Saved Articles. 4 | 5 | ## Configuration 6 | 7 | ```yaml 8 | pocket: 9 | enabled: true 10 | position: 11 | top: 0 12 | left: 3 13 | height: 4 14 | width: 2 15 | consumerKey: '88*******************' 16 | refreshInterval: 1s 17 | ``` 18 | 19 | ## Attributes 20 | 21 | 22 | {% include "attributes/table_header.md" %} 23 | 24 | 25 | {% with name="consumer_key", desc="The consumer key of Pocket app obtained from https://getpocket.com/developer/apps/new. Make sure to have add, modify, and retrieve permissions.", value="" %} 26 | {% include "attributes/custom.md" %} 27 | {% endwith %} 28 | 29 |
30 | 31 | ## Keyboard 32 | 33 | 34 | {% include "keyboard/table_header.md" %} 35 | 36 | 37 | {% include "keyboard/foreslash.md" %} 38 | 39 | {% set return="Open the article in the browser" %} 40 | {% include "keyboard/return.md" %} 41 | 42 | {% include "keyboard/spacer.md" %} 43 | 44 | {% set a="Toggle link archive/unarchive" %} 45 | {% include "keyboard/a.md" %} 46 | 47 | {% include "keyboard/j.md" %} 48 | {% include "keyboard/k.md" %} 49 | 50 | {% set t="Toggle view archived links/active links" %} 51 | {% include "keyboard/t.md" %} 52 | 53 | {% include "keyboard/spacer.md" %} 54 | 55 | {% include "keyboard/arrowDown.md" %} 56 | {% include "keyboard/arrowUp.md" %} 57 | 58 |
59 | 60 | {% set src="pocket" %} 61 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/power.md: -------------------------------------------------------------------------------- 1 | # Power 2 | 3 | Displays information about the current power source. 4 | 5 | For battery, also displays the current charge, estimated time remaining, and whether it is charging or discharging. 6 | 7 | ## Configuration 8 | 9 | ```yaml 10 | power: 11 | enabled: true 12 | position: 13 | top: 5 14 | left: 0 15 | height: 2 16 | width: 1 17 | refreshInterval: 15s 18 | ``` 19 | 20 | ## Screenshots 21 | 22 | power screenshot 23 | 24 | {% set src="power" %} 25 | {% include "src_path.md" %} 26 | 27 | ## Dependencies 28 | 29 | ### Linux 30 | 31 | [upower](https://upower.freedesktop.org/) 32 | 33 | ### FreeBSD 34 | 35 | [apm](https://www.freebsd.org/cgi/man.cgi?apm) 36 | 37 | ### MacOS 38 | 39 | [pmset](https://en.wikipedia.org/wiki/Pmset) -------------------------------------------------------------------------------- /docs/modules/sports/nbascore.md: -------------------------------------------------------------------------------- 1 | # NBA Score 2 | 3 | Displays NBA game scores. 4 | 5 | ## Configuration 6 | 7 | ```yaml 8 | nbascore: 9 | enabled: true 10 | position: 11 | top: 1 12 | left: 2 13 | height: 1 14 | width: 1 15 | refreshInterval: 10m 16 | ``` 17 | 18 | ## Keyboard 19 | 20 | 21 | {% include "keyboard/table_header.md" %} 22 | 23 | 24 | {% include "keyboard/foreslash.md" %} 25 | 26 | {% include "keyboard/spacer.md" %} 27 | 28 | {% set c="Go to current day" %} 29 | {% include "keyboard/c.md" %} 30 | 31 | {% set h="Go to previous day" %} 32 | {% include "keyboard/h.md" %} 33 | 34 | {% set l="Go to next day" %} 35 | {% include "keyboard/l.md" %} 36 | 37 | {% include "keyboard/r.md" %} 38 | 39 | {% include "keyboard/spacer.md" %} 40 | 41 | {% set arrowBack="Go to previous day" %} 42 | {% include "keyboard/arrowBack.md" %} 43 | 44 | {% set arrowFore="Go to next day" %} 45 | {% include "keyboard/arrowFore.md" %} 46 | 47 |
48 | 49 | {% set src="nbascore" %} 50 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/spotify.md: -------------------------------------------------------------------------------- 1 | # Spotify 2 | 3 | Control the Spotify client. 4 | 5 | ## Configuration 6 | 7 | ```yaml 8 | spotify: 9 | enabled: true 10 | colors: 11 | label: "green" 12 | text: "white" 13 | position: 14 | top: 1 15 | left: 2 16 | height: 1 17 | width: 1 18 | refreshInterval: 0 19 | ``` 20 | 21 | ## Attributes 22 | 23 | 24 | {% include "attributes/table_header.md" %} 25 | 26 | 27 | {% with name="colors.label", desc="Optional The color for labels. Default: green." %} 28 | {% include "attributes/colors/custom.md" %} 29 | {% endwith %} 30 | 31 | {% with name="colors.text", desc="Optional The color for text. Default: white." %} 32 | {% include "attributes/colors/custom.md" %} 33 | {% endwith %} 34 | 35 |
36 | 37 | ## Keyboard 38 | 39 | 40 | {% include "keyboard/table_header.md" %} 41 | 42 | 43 | {% include "keyboard/foreslash.md" %} 44 | 45 | {% set return="Open the selected item in the browser" %} 46 | {% include "keyboard/return.md" %} 47 | 48 | {% set space="Play/pause the currently-selected song" %} 49 | {% include "keyboard/space.md" %} 50 | 51 | {% include "keyboard/spacer.md" %} 52 | 53 | {% set h="Play previous song" %} 54 | {% include "keyboard/h.md" %} 55 | 56 | {% set l="Play next song" %} 57 | {% include "keyboard/l.md" %} 58 | 59 | {% include "keyboard/r.md" %} 60 | 61 |
62 | 63 | {% set src="spotify" %} 64 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/stocks/finnhub.md: -------------------------------------------------------------------------------- 1 | # Finnhub 2 | 3 | Display Finnhub stocks for the configured symbols. 4 | 5 | ## Configuration 6 | 7 | ```yaml 8 | finnhub: 9 | apiKey: "your-api-key" 10 | symbols: 11 | - "AAPL" 12 | - "MSFT" 13 | - "AMZN" 14 | - "FSLY" 15 | enabled: true 16 | position: 17 | top: 0 18 | left: 0 19 | height: 2 20 | width: 2 21 | refreshInterval: 5s 22 | ``` 23 | 24 | ## Attributes 25 | 26 | 27 | {% include "attributes/table_header.md" %} 28 | 29 | 30 | {% with name="apiKey", desc="Your finnhub.io api key.", value="A valid API key." %} 31 | {% include "attributes/custom.md" %} 32 | {% endwith %} 33 | 34 | {% with name="symbols", desc="List of symbols to display.", value="List of symbols." %} 35 | {% include "attributes/custom.md" %} 36 | {% endwith %} 37 | 38 |
39 | 40 | {% set src="stocks/finnhub" %} 41 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/stocks/yfinance.md: -------------------------------------------------------------------------------- 1 | # Yahoo Finance 2 | 3 | Display Yahoo Finance data for the configured symbols. 4 | 5 | The first column shows the symbol's status: 6 | 7 | * pre-market: ⏭ 8 | * open: ▶ 9 | * post-market: ⏮ 10 | * closed: ⏹ 11 | 12 | The second column is the symbol's shortname, third column shows the current value. 13 | The fourth columns will show a different icon depending on the current market change: 14 | 15 | * >3%: ⬆️ 16 | * >0%: ↗️ 17 | * <0%: ↘️ 18 | * <-3%: ⬇️ 19 | 20 | ## Configuration 21 | 22 | ```yaml 23 | yfinance: 24 | enabled: true 25 | title: "Stock and exchange rate 🚀" 26 | sort: true 27 | refreshInterval: 1m 28 | symbols: 29 | - "DOCN" 30 | - "GLE.PA" 31 | - "ABN.AS" 32 | - "ICAD.PA" 33 | - "ACA.PA" 34 | - "ORA.PA" 35 | - "EURUSD=X" 36 | - "USDCAD=X" 37 | - "CADJPY=X" 38 | position: 39 | top: 1 40 | left: 0 41 | height: 1 42 | width: 1 43 | ``` 44 | 45 | ## Screenshots 46 | 47 | yfinance screenshot 48 | 49 | ## Attributes 50 | 51 | 52 | {% include "attributes/table_header.md" %} 53 | 54 | 55 | {% with name="symbols", desc="List of Yahoo Finance symbols to display.", value="List of valid Yahoo Finance symbols." %} 56 | {% include "attributes/custom.md" %} 57 | {% endwith %} 58 | 59 | {% with name="sort", desc="Optional Sort indices by market change percent. Default: false.", value="true, false" %} 60 | {% include "attributes/custom.md" %} 61 | {% endwith %} 62 | 63 |
64 | 65 | {% set src="stocks/yfinance" %} 66 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/todoist.md: -------------------------------------------------------------------------------- 1 | # Todoist 2 | 3 | Displays all items on specified project. 4 | 5 | ## Configuration 6 | 7 | ```yaml 8 | todoist: 9 | apiKey: "p0d13*********************************************c3" 10 | enabled: true 11 | position: 12 | top: 0 13 | left: 2 14 | height: 1 15 | width: 1 16 | projects: 17 | - 122247497 18 | refreshInterval: 1h 19 | ``` 20 | 21 | ## Screenshots 22 | 23 | todoist screenshot 24 | 25 | ## Attributes 26 | 27 | 28 | {% include "attributes/table_header.md" %} 29 | 30 | 31 | {% with name="Todoist", envvar="WTF_TODOIST_TOKEN" %} 32 | {% include "attributes/apikey.md" %} 33 | {% endwith %} 34 | 35 | {% with name="projects", desc="The todoist projects to fetch items from.", value="The integer ID of the project." %} 36 | {% include "attributes/custom.md" %} 37 | {% endwith %} 38 | 39 |
40 | 41 | ## Keyboard 42 | 43 | 44 | {% include "keyboard/table_header.md" %} 45 | 46 | 47 | {% include "keyboard/foreslash.md" %} 48 | 49 | {% set esc="Remove focus from the selected item" %} 50 | {% include "keyboard/esc.md" %} 51 | 52 | {% include "keyboard/spacer.md" %} 53 | 54 | {% set c="Close current item" %} 55 | {% include "keyboard/c.md" %} 56 | 57 | {% set d="Delete current item" %} 58 | {% include "keyboard/d.md" %} 59 | 60 | {% set h="Show the previous project" %} 61 | {% include "keyboard/h.md" %} 62 | 63 | {% include "keyboard/j.md" %} 64 | {% include "keyboard/k.md" %} 65 | 66 | {% set l="Show the next project" %} 67 | {% include "keyboard/l.md" %} 68 | 69 | {% set u="Clear the current selection" %} 70 | {% include "keyboard/u.md" %} 71 | 72 | {% include "keyboard/spacer.md" %} 73 | 74 | {% set arrowBack="Show the previous project" %} 75 | {% include "keyboard/arrowBack.md" %} 76 | 77 | {% set arrowFore="Show the next project" %} 78 | {% include "keyboard/arrowFore.md" %} 79 | 80 | {% include "keyboard/arrowDown.md" %} 81 | {% include "keyboard/arrowUp.md" %} 82 | 83 |
84 | 85 | {% set src="todo_plus" %} 86 | {% include "src_path.md" %} 87 | -------------------------------------------------------------------------------- /docs/modules/transmission.md: -------------------------------------------------------------------------------- 1 | ![transmission](/assets/services/transmission.png){: align=left width=128 height=128} 2 | 3 | # Transmission 4 | 5 | View and manage your [Transmission](https://transmissionbt.com) bittorrent daemon. This widget shows you the currently-loaded 6 | torrents, their "download complete" percentage, and their seeding status. 7 | 8 | ## Configuration 9 | 10 | ```yaml 11 | transmission: 12 | enabled: true 13 | host: "192.168.1.5" 14 | password: "passwordpassword" 15 | position: 16 | top: 4 17 | left: 3 18 | width: 2 19 | height: 1 20 | refreshInterval: 3s 21 | username: "transmission" 22 | ``` 23 | 24 | ## Screenshots 25 | 26 | transmission screenshot 27 | 28 | ## Attributes 29 | 30 | 31 | {% include "attributes/table_header.md" %} 32 | 33 | 34 | {% with name="host", desc="The IP address of the machine that your Transmission daemon is running on.", value="" %} 35 | {% include "attributes/custom.md" %} 36 | {% endwith %} 37 | 38 | {% set service="Transmission" %} 39 | {% set pwdesc="The password you use to connect to your Transmission daemon." %} 40 | {% include "attributes/password.md" %} 41 | 42 | {% set service="Transmission" %} 43 | {% set undesc="The username you use to connect to your Transmission daemon." %} 44 | {% include "attributes/username.md" %} 45 | 46 |
47 | 48 | 49 | {% include "keyboard/table_header.md" %} 50 | 51 | 52 | {% include "keyboard/foreslash.md" %} 53 | 54 | {% set return="Pause/resume the selected torrent" %} 55 | {% include "keyboard/return.md" %} 56 | 57 | {% include "keyboard/spacer.md" %} 58 | 59 | {% include "keyboard/j.md" %} 60 | {% include "keyboard/k.md" %} 61 | {% include "keyboard/r.md" %} 62 | 63 | {% include "keyboard/spacer.md" %} 64 | 65 | {% include "keyboard/arrowDown.md" %} 66 | {% include "keyboard/arrowUp.md" %} 67 | 68 | {% include "keyboard/spacer.md" %} 69 | 70 | {% include "keyboard/ctrlD.md" %} 71 | 72 |
73 | 74 | {% set src="transmission" %} 75 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/trello.md: -------------------------------------------------------------------------------- 1 | # Trello 2 | 3 | Displays all Trello cards on specified lists. 4 | 5 | ## Configuration 6 | 7 | ### Single Trello List 8 | 9 | ```yaml 10 | trello: 11 | accessToken: "d23*******************************************3r2" 12 | apiKey: "p0d13*********************************************c3" 13 | board: Main 14 | enabled: true 15 | list: "Todo" 16 | position: 17 | height: 1 18 | left: 2 19 | top: 0 20 | width: 1 21 | refreshInterval: 1h 22 | username: myname 23 | ``` 24 | 25 | ### Multiple Trello Lists 26 | 27 | If you want to monitor multiple Trello lists, use the following 28 | configuration (note the difference in `list`): 29 | 30 | ```yaml 31 | trello: 32 | accessToken: "d23*******************************************3r2" 33 | apiKey: "p0d13*********************************************c3" 34 | board: Main 35 | enabled: true 36 | list: ["Todo", "Done"] 37 | position: 38 | height: 1 39 | left: 2 40 | top: 0 41 | width: 1 42 | refreshInterval: 1h 43 | username: myname 44 | ``` 45 | 46 | ## Screenshots 47 | 48 | trello screenshot 49 | 50 | ## Attributes 51 | 52 | 53 | {% include "attributes/table_header.md" %} 54 | 55 | 56 | {% with name="accessToken", desc="Your Trello access token. Leave empty to use the WTF_TRELLO_ACCESS_TOKEN environment variable.", value="" %} 57 | {% include "attributes/custom.md" %} 58 | {% endwith %} 59 | 60 | {% with name="Trello", envvar="WTF_TRELLO_API_KEY" %} 61 | {% include "attributes/apikey.md" %} 62 | {% endwith %} 63 | 64 | {% with name="board", desc="The name of the Trello board.", value="" %} 65 | {% include "attributes/custom.md" %} 66 | {% endwith %} 67 | 68 | {% with name="list", desc="The Trello lists to fetch cards from.", value="" %} 69 | {% include "attributes/custom.md" %} 70 | {% endwith %} 71 | 72 | {% set service="Trello" %} 73 | {% include "attributes/username.md" %} 74 | 75 | 76 |
77 | 78 | {% set src="todo_plus" %} 79 | {% include "src_path.md" %} 80 | -------------------------------------------------------------------------------- /docs/modules/updown.md: -------------------------------------------------------------------------------- 1 | # Updown 2 | 3 | Connect to the [Updown](https://updown.io) API. 4 | 5 | ## Configuration 6 | 7 | ```yaml 8 | updown: 9 | type: updown 10 | apiKey: "XXXX" 11 | tokens: 12 | - YYYY 13 | position: 14 | top: 0 15 | left: 1 16 | height: 2 17 | width: 1 18 | ``` 19 | 20 | ## Screenshots 21 | 22 | Updown screenshot 23 | 24 | 25 | ## Attributes 26 | 27 | 28 | {% include "attributes/table_header.md" %} 29 | 30 | 31 | {% with name="Updown", envvar="WTF_UPDOWN_APIKEY" %} 32 | {% include "attributes/apikey.md" %} 33 | {% endwith %} 34 | 35 | {% with name="apiKey", desc="Updown read-only API-key", value="string" %} 36 | {% include "attributes/custom.md" %} 37 | {% endwith %} 38 | 39 | {% with name="tokens", desc="Only show checks with specified tokens", value="list" %} 40 | {% include "attributes/custom.md" %} 41 | {% endwith %} 42 | 43 |
44 | 45 | {% set src="updown" %} 46 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/uptimerobot.md: -------------------------------------------------------------------------------- 1 | # UptimeRobot 2 | 3 | Connect to the [UptimeRobot](https://uptimerobot.com) API. 4 | 5 | ## Configuration 6 | 7 | ```yaml 8 | uptimerobot: 9 | apiKey: "p0d13*********************************************c3" 10 | enabled: true 11 | offlineFirst: true 12 | position: 13 | top: 0 14 | left: 1 15 | height: 2 16 | width: 1 17 | refreshInterval: 1h 18 | uptimePeriods: 7-30 19 | ``` 20 | 21 | ## Attributes 22 | 23 | 24 | {% include "attributes/table_header.md" %} 25 | 26 | 27 | {% with name="UptimeRobot", envvar="WTF_UPTIMEROBOT_APIKEY" %} 28 | {% include "attributes/apikey.md" %} 29 | {% endwith %} 30 | 31 | {% with name="offlineFirst", desc="Optional Display offline monitors at the top.", value="true, false" %} 32 | {% include "attributes/custom.md" %} 33 | {% endwith %} 34 | 35 | {% with name="uptimePeriods", desc="Optional he periods over which to display uptime (in days, dash-separated).", value="" %} 36 | {% include "attributes/custom.md" %} 37 | {% endwith %} 38 | 39 |
40 | 41 | {% set src="uptimerobot" %} 42 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/urlcheck.md: -------------------------------------------------------------------------------- 1 | # Urlcheck 2 | 3 | Checks if your URLs are responding. 4 | 5 | This module will continously request the headers for a given list of URLs and then displays theirs status codes. 6 | 7 | ## Configuration 8 | 9 | ```yaml 10 | urlcheck: 11 | enabled: true 12 | timeout: 25 13 | urls: 14 | - http://go.dev # ok 15 | - https://wtfutil.com # ok 16 | - wtfutil.com # invalid url 17 | - http://www.nope.nope # dns error 18 | - https://httpbin.org/status/500 # Internal server error 19 | position: 20 | top: 0 21 | left: 0 22 | height: 1 23 | width: 1 24 | refreshInterval: 30 25 | ``` 26 | 27 | ## Screenshots 28 | 29 | urlcheck screenshot 30 | 31 | ## Attributes 32 | 33 | 34 | {% include "attributes/table_header.md" %} 35 | 36 | 37 | 38 | 44 | 45 | 46 | 47 | 52 | 53 | 54 | 55 |
39 | timeout 40 |
41 | Optional The amountof time allowed to a single request to complete. Default: 30. 42 | 43 | 		A positive integer.
48 | urls 49 |
50 | Required The URLs to be requested. The protocol is required too (Ex.: http://go.dev). 51 | 		A list of strings.
56 | 57 | ## Logging 58 | 59 | These events will be logged in the standard logger: 60 | * Timeouts, 61 | * DNS lookup errors, 62 | * other generals Request errors. 63 | 64 | {% set src="urlcheck" %} 65 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/victorops.md: -------------------------------------------------------------------------------- 1 | # VictorOps 2 | 3 | Connects to the VictorOps API and determines who is on call. 4 | 5 | ## Configuration 6 | 7 | ```yaml 8 | victorops: 9 | apiID: a3c5dd63 10 | apiKey: "p0d13*********************************************c3" 11 | enabled: true 12 | position: 13 | top: 0 14 | left: 1 15 | height: 2 16 | width: 1 17 | refreshInterval: 1h 18 | team: devops 19 | ``` 20 | 21 | ## Attributes 22 | 23 | 24 | {% include "attributes/table_header.md" %} 25 | 26 | 27 | {% with name="apiID", desc="Your VictorOps API ID token. Leave this empty to use the WTF_VICTOROPS_API_ID environment variable.", value="" %} 28 | {% include "attributes/custom.md" %} 29 | {% endwith %} 30 | 31 | {% with name="VictorOps", envvar="WTF_VICTOROPS_API_KEY" %} 32 | {% include "attributes/apikey.md" %} 33 | {% endwith %} 34 | 35 | {% with name="team", desc="Optional Whether or not to only show a specific team. Default: all teams are shown.", value="The team slug that can be found in the URL after /#/team/." %} 36 | {% include "attributes/custom.md" %} 37 | {% endwith %} 38 | 39 |
40 | 41 | {% set src="victorops" %} 42 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/weather_services/arpansagovau.md: -------------------------------------------------------------------------------- 1 | # ARPANSA 2 | 3 | Displays Ultraviolet radiation index information from ARPANSA for an Australian city to help determine what level of sun protection or avoidance is necessary. 4 | 5 | The [Australian Radiation Protection and Nuclear Safety Agency](https://www.arpansa.gov.au) (ARPANSA) is the Australian Government's primary authority on radiation protection and nuclear safety. 6 | 7 | Interpreting the information: 8 | 9 | * Index is specified in units of [Standard Erthermal Dose](https://www.arpansa.gov.au/services/monitoring/ultraviolet-radiation-monitoring/ultraviolet-radiation-dose/ultraviolet). 10 | * If the UV index is less than 3 you can safely stay outdoors with minimal protection. 11 | * If the UV index is 3 or more: wear sun protective clothing, a hat, sunglasses, sunscreen, seek shade. 12 | 13 | ## Configuration 14 | 15 | ```yaml 16 | arpansagovau: 17 | enabled: true 18 | locationid: "Sydney" 19 | position: 20 | top: 0 21 | left: 0 22 | height: 1 23 | width: 1 24 | refreshInterval: 15m 25 | ``` 26 | 27 | arpansagovau module screenshot 28 | 29 | ## Attributes 30 | 31 | 32 | {% include "attributes/table_header.md" %} 33 | 34 | 35 | {% with name="locationid", desc="One of the ARPANSA location ids as seen on the id attribute of the location tag. e.g. 'Sydney'", value="" %} 36 | {% include "attributes/custom.md" %} 37 | {% endwith %} 38 | 39 |
40 | 41 | {% set src="weatherservices/arpansagovau" %} 42 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/weather_services/prettyweather.md: -------------------------------------------------------------------------------- 1 | # Pretty Weather 2 | 3 | Displays weather information as ASCII art from [Wttr.in](http://wttr.in). 4 | 5 | Consider using wego directly, to avoid issues with rate limiting. 6 | See [wego](../../cmdrunner/wego). 7 | 8 | ## Configuration 9 | 10 | ```yaml 11 | prettyweather: 12 | enabled: true 13 | city: "tehran" 14 | position: 15 | top: 3 16 | left: 5 17 | height: 1 18 | width: 1 19 | refreshInterval: 5m 20 | unit: "m" 21 | view: 0 22 | language: "en" 23 | ``` 24 | 25 | prettyweather screenshot 26 | 27 | ## Attributes 28 | 29 | 30 | {% include "attributes/table_header.md" %} 31 | 32 | 33 | {% with name="city", desc="Optional The name of the city to display weather for. Default: Barcelona.", value="The name of any city supported by Wttr.in." %} 34 | {% include "attributes/custom.md" %} 35 | {% endwith %} 36 | 37 | {% with name="language", desc="Optional Wttr.in language configuration. Default: en.", value="See curl wttr.in/:translation for more details." %} 38 | {% include "attributes/custom.md" %} 39 | {% endwith %} 40 | 41 | {% with name="unit", desc="Optional The scale to display temperatures in. Default: m.", value="u for Fahrenheit, m for Celsius." %} 42 | {% include "attributes/custom.md" %} 43 | {% endwith %} 44 | 45 | {% with name="view", desc="Optional Wttr.in view configuration.", value="See curl wttr.in/:help for more details." %} 46 | {% include "attributes/custom.md" %} 47 | {% endwith %} 48 | 49 |
50 | 51 | 52 | {% set src="weatherservices/prettyweather" %} 53 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/modules/zendesk.md: -------------------------------------------------------------------------------- 1 | # Zendesk 2 | 3 | Displays Zendesk tickets. 4 | 5 | ## Configuration 6 | 7 | ```yaml 8 | zendesk: 9 | apiKey: "p0d13*********************************************c3" 10 | enabled: true 11 | position: 12 | top: 0 13 | left: 2 14 | height: 1 15 | width: 1 16 | status: "new" 17 | subdomain: "your_domain" 18 | username: "your_email@acme.com" 19 | ``` 20 | 21 | ## Attributes 22 | 23 | 24 | {% include "attributes/table_header.md" %} 25 | 26 | 27 | {% with name="Zendesk", envvar="ZENDESK_API" %} 28 | {% include "attributes/apikey.md" %} 29 | {% endwith %} 30 | 31 | {% with name="status", desc="The status of tickets you want to retrieve.", value="new, open, pending, hold" %} 32 | {% include "attributes/custom.md" %} 33 | {% endwith %} 34 | 35 | {% with name="subdomain", desc="Your Zendesk subdomain. Leave this empty to use the ZENDESK_SUBDOMAIN environment variable.", value="" %} 36 | {% include "attributes/custom.md" %} 37 | {% endwith %} 38 | 39 | {% set name="Zendesk" %} 40 | {% include "attributes/username.md" %} 41 | 42 |
43 | 44 | ## Keyboard 45 | 46 | 47 | {% include "keyboard/table_header.md" %} 48 | 49 | 50 | {% include "keyboard/foreslash.md" %} 51 | 52 | {% set return="Open the selected ticket in the browser" %} 53 | {% include "keyboard/return.md" %} 54 | 55 | {% include "keyboard/spacer.md" %} 56 | 57 | {% include "keyboard/j.md" %} 58 | {% include "keyboard/k.md" %} 59 | 60 | {% include "keyboard/spacer.md" %} 61 | 62 | {% include "keyboard/arrowDown.md" %} 63 | {% include "keyboard/arrowUp.md" %} 64 | 65 |
66 | 67 | {% set src="zendesk" %} 68 | {% include "src_path.md" %} -------------------------------------------------------------------------------- /docs/overrides/assets/display_screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/display_screenshot.png -------------------------------------------------------------------------------- /docs/overrides/assets/exit_message.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/exit_message.png -------------------------------------------------------------------------------- /docs/overrides/assets/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/logo.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/airbrake.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/airbrake.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/arpansa.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/arpansa.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/asana.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/asana.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/bittrex.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/bittrex.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/blockfolio.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/blockfolio.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/cds_favorites.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/cds_favorites.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/cds_queue.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/cds_queue.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/cds_status.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/cds_status.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/circleci.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/circleci.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/clocks.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/clocks.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/cmdrunner/iStats.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/cmdrunner/iStats.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/cmdrunner/slackstatus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/cmdrunner/slackstatus.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/cmdrunner/wego.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/cmdrunner/wego.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/cryptolive.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/cryptolive.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/datadog_error.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/datadog_error.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/datadog_ok.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/datadog_ok.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/devto.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/devto.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/digitalclock-small.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/digitalclock-small.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/digitalclock.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/digitalclock.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/digitalocean.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/digitalocean.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/digitalocean_droplet_info.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/digitalocean_droplet_info.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/docker.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/docker.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/feedreader.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/feedreader.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/football.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/football.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/gcal.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/gcal.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/gerrit.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/gerrit.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/git.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/git.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/github.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/github.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/gitlab.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/gitlab.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/gitter.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/gitter.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/google_analytics.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/google_analytics.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/hackernews.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/hackernews.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/healthchecks.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/healthchecks.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/hibp.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/hibp.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/ipinfo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/ipinfo.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/jenkins.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/jenkins.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/jira.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/jira.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/krisinformation.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/krisinformation.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/lunarphase-fr.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/lunarphase-fr.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/lunarphase.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/lunarphase.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/mempool.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/mempool.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/mercurial.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/mercurial.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/newrelic.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/newrelic.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/nextbus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/nextbus.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/opsgenie.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/opsgenie.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/pihole.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/pihole.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/power.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/power.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/prettyweather.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/prettyweather.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/resource_usage.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/resource_usage.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/rollbar.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/rollbar.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/security.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/security.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/subreddit.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/subreddit.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/textfile.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/textfile.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/todo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/todo.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/todoist.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/todoist.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/transmission.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/transmission.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/travisci.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/travisci.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/trello.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/trello.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/updown.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/updown.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/url_check.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/url_check.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/weather-compact.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/weather-compact.png -------------------------------------------------------------------------------- /docs/overrides/assets/modules/weather.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/modules/weather.png -------------------------------------------------------------------------------- /docs/overrides/assets/screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/screenshot.png -------------------------------------------------------------------------------- /docs/overrides/assets/services/digitalocean.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/services/digitalocean.png -------------------------------------------------------------------------------- /docs/overrides/assets/services/docker.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/services/docker.png -------------------------------------------------------------------------------- /docs/overrides/assets/services/gcal.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/services/gcal.png -------------------------------------------------------------------------------- /docs/overrides/assets/services/git.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/services/git.png -------------------------------------------------------------------------------- /docs/overrides/assets/services/github.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/services/github.png -------------------------------------------------------------------------------- /docs/overrides/assets/services/pagerduty.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/services/pagerduty.jpg -------------------------------------------------------------------------------- /docs/overrides/assets/services/pihole.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/services/pihole.png -------------------------------------------------------------------------------- /docs/overrides/assets/services/transmission.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/services/transmission.png -------------------------------------------------------------------------------- /docs/overrides/assets/services/twitter.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/services/twitter.png -------------------------------------------------------------------------------- /docs/overrides/assets/services/weather.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/services/weather.jpg -------------------------------------------------------------------------------- /docs/overrides/assets/sponsors/airbrake.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/sponsors/airbrake.png -------------------------------------------------------------------------------- /docs/overrides/assets/sponsors/robusta.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/sponsors/robusta.png -------------------------------------------------------------------------------- /docs/overrides/assets/sponsors/warp.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/sponsors/warp.png -------------------------------------------------------------------------------- /docs/overrides/assets/sponsors/warp2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/sponsors/warp2.png -------------------------------------------------------------------------------- /docs/overrides/assets/sponsors/warp3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/docs/overrides/assets/sponsors/warp3.png -------------------------------------------------------------------------------- /docs/overrides/main.html: -------------------------------------------------------------------------------- 1 | {% extends "base.html" %} 2 | {% block extrahead %} 3 | {% set title = config.site_name %} 4 | {% if page and page.title and not page.is_homepage %} 5 | {% set title = config.site_name ~ " - " ~ page.title | striptags %} 6 | {% endif %} 7 | {% set image = config.site_url ~ 'static/card.png' %} 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | {% endblock %} -------------------------------------------------------------------------------- /docs/quick_start.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Getting Started" 3 | date: 2018-05-21T16:11:58-07:00 4 | draft: false 5 | weight: 10 6 | alwaysopen: true 7 | --- 8 | 9 | ## Quick Start 10 | 11 | `❯ brew install wtfutil` 12 | 13 | or 14 | 15 | 1. Download the stand-alone, compiled binary. 16 | 2. Unzip the downloaded file. 17 | 3. From the command line, `cd` into the newly-created `/wtf` directory. 18 | 4. From the command line, run the app: `./wtfutil` 19 | 20 | This should launch the app in your terminal using the default simple 21 | configuration. See [Configuration](/configuration/files) for 22 | more details. 23 | 24 | See [Installation](/installation/) for additional installation options. 25 | 26 | ## Command-line Options 27 | 28 | `--config, -c`
29 | Allows you to define a custom config file to use. See [Configuration](/configuration/files) for more details. 30 | 31 | `--help, -h`
32 | Shows help information for the command-line arguments that WTF takes. 33 | 34 | `--module, -m`
35 | Shows help information for the specific named module, if that module supports help text. 36 | 37 | Example: `wtf --module=todo`. 38 | 39 | `--version, -v`
40 | Shows version info. 41 | 42 | ## Keyboard Commands 43 | 44 | Key: `Q` or `q`
45 | Action: Quit WTF. 46 | 47 | Key: `Ctrl-R`
48 | Action: Force-refresh the data for all modules. 49 | 50 | Key: `Esc`
51 | Action: Remove focus the currently-focused 52 | widget. 53 | 54 | Key: `Tab`
55 | Action: Move between focusable modules (`Shift-Tab` to move backwards). 56 | -------------------------------------------------------------------------------- /docs/sponsors/exit_message.md: -------------------------------------------------------------------------------- 1 | # Exit Message 2 | 3 | On exit, WTF displays a short text message pointing people to the sponsorship page: 4 | 5 | ![Exit Message](/assets/exit_message.png){: width=600 } 6 | 7 | People who contribute code or sponsor the project will see a different, customized message. 8 | 9 | Code contributors and sponsors of WTF can also opt out of seeing the exit message entirely by including the following configuration in their conf file: 10 | 11 | ```bash 12 | wtf: 13 | exitMessage: 14 | display: false 15 | githubAPIKey: "d8....................................ea" 16 | ``` 17 | WTF uses the GitHub API key to determine who the contributors and sponsors are. -------------------------------------------------------------------------------- /docs/uninstallation.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Uninstallation" 3 | date: 2018-01-28T09:59:40-07:00 4 | draft: false 5 | weight: 10 6 | --- 7 | 8 | # Uninstallation 9 | 10 | ## Homebrew 11 | 12 | ```bash 13 | ❯ brew uninstall wtfutil 14 | ``` 15 | 16 | ## Remove the Binary and Configuration 17 | 18 | WTF ships as a single binary named `wtfutil`. Assuming you have installed the binary, run: 19 | 20 | ```bash 21 | ❯ rm $(which wtfutil) 22 | ``` 23 | 24 | If you have configured WTF, you will also want to delete your configs: 25 | 26 | ```bash 27 | ❯ rm -r ~/.config/wtf 28 | ``` 29 | 30 | and that should also do it. 31 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | certifi==2022.9.14 2 | charset-normalizer==2.1.1 3 | click==8.1.3 4 | ghp-import==2.1.0 5 | idna==3.4 6 | importlib-metadata==4.12.0 7 | Jinja2==3.1.2 8 | Markdown==3.3.7 9 | MarkupSafe==2.1.1 10 | mergedeep==1.3.4 11 | mkdocs==1.3.1 12 | mkdocs-macros-plugin==0.7.0 13 | mkdocs-material==8.5.3 14 | mkdocs-material-extensions==1.0.3 15 | packaging==21.3 16 | Pygments==2.13.0 17 | pymdown-extensions==9.5 18 | pyparsing==3.0.9 19 | python-dateutil==2.8.2 20 | PyYAML==6.0 21 | pyyaml_env_tag==0.1 22 | requests==2.28.1 23 | six==1.16.0 24 | termcolor==2.0.1 25 | urllib3==1.26.12 26 | watchdog==2.1.9 27 | zipp==3.8.1 28 | -------------------------------------------------------------------------------- /site/CNAME: -------------------------------------------------------------------------------- 1 | wtfutil.com 2 | -------------------------------------------------------------------------------- /site/assets/display_screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/site/assets/display_screenshot.png -------------------------------------------------------------------------------- /site/assets/exit_message.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/site/assets/exit_message.png -------------------------------------------------------------------------------- /site/assets/images/favicon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/site/assets/images/favicon.png -------------------------------------------------------------------------------- /site/assets/javascripts/lunr/min/lunr.hi.min.js: -------------------------------------------------------------------------------- 1 | !function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.hi=function(){this.pipeline.reset(),this.pipeline.add(e.hi.trimmer,e.hi.stopWordFilter,e.hi.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.hi.stemmer))},e.hi.wordCharacters="ऀ-ःऄ-एऐ-टठ-यर-िी-ॏॐ-य़ॠ-९॰-ॿa-zA-Zａ-ｚＡ-Ｚ0-9０-９",e.hi.trimmer=e.trimmerSupport.generateTrimmer(e.hi.wordCharacters),e.Pipeline.registerFunction(e.hi.trimmer,"trimmer-hi"),e.hi.stopWordFilter=e.generateStopWordFilter("अत अपना अपनी अपने अभी अंदर आदि आप इत्यादि इन इनका इन्हीं इन्हें इन्हों इस इसका इसकी इसके इसमें इसी इसे उन उनका उनकी उनके उनको उन्हीं उन्हें उन्हों उस उसके उसी उसे एक एवं एस ऐसे और कई कर करता करते करना करने करें कहते कहा का काफ़ी कि कितना किन्हें किन्हों किया किर किस किसी किसे की कुछ कुल के को कोई कौन कौनसा गया घर जब जहाँ जा जितना जिन जिन्हें जिन्हों जिस जिसे जीधर जैसा जैसे जो तक तब तरह तिन तिन्हें तिन्हों तिस तिसे तो था थी थे दबारा दिया दुसरा दूसरे दो द्वारा न नके नहीं ना निहायत नीचे ने पर पहले पूरा पे फिर बनी बही बहुत बाद बाला बिलकुल भी भीतर मगर मानो मे में यदि यह यहाँ यही या यिह ये रखें रहा रहे ऱ्वासा लिए लिये लेकिन व वग़ैरह वर्ग वह वहाँ वहीं वाले वुह वे वो सकता सकते सबसे सभी साथ साबुत साभ सारा से सो संग ही हुआ हुई हुए है हैं हो होता होती होते होना होने".split(" ")),e.hi.stemmer=function(){return function(e){return"function"==typeof e.update?e.update(function(e){return e}):e}}();var r=e.wordcut;r.init(),e.hi.tokenizer=function(i){if(!arguments.length||null==i||void 0==i)return[];if(Array.isArray(i))return i.map(function(r){return isLunr2?new e.Token(r.toLowerCase()):r.toLowerCase()});var t=i.toString().toLowerCase().replace(/^\s+/,"");return r.cut(t).split("|")},e.Pipeline.registerFunction(e.hi.stemmer,"stemmer-hi"),e.Pipeline.registerFunction(e.hi.stopWordFilter,"stopWordFilter-hi")}}); -------------------------------------------------------------------------------- /site/assets/javascripts/lunr/min/lunr.ja.min.js: -------------------------------------------------------------------------------- 1 | !function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");var r="2"==e.version[0];e.ja=function(){this.pipeline.reset(),this.pipeline.add(e.ja.trimmer,e.ja.stopWordFilter,e.ja.stemmer),r?this.tokenizer=e.ja.tokenizer:(e.tokenizer&&(e.tokenizer=e.ja.tokenizer),this.tokenizerFn&&(this.tokenizerFn=e.ja.tokenizer))};var t=new e.TinySegmenter;e.ja.tokenizer=function(i){var n,o,s,p,a,u,m,l,c,f;if(!arguments.length||null==i||void 0==i)return[];if(Array.isArray(i))return i.map(function(t){return r?new e.Token(t.toLowerCase()):t.toLowerCase()});for(o=i.toString().toLowerCase().replace(/^\s+/,""),n=o.length-1;n>=0;n--)if(/\S/.test(o.charAt(n))){o=o.substring(0,n+1);break}for(a=[],s=o.length,c=0,l=0;c<=s;c++)if(u=o.charAt(c),m=c-l,u.match(/\s/)||c==s){if(m>0)for(p=t.segment(o.slice(l,c)).filter(function(e){return!!e}),f=l,n=0;n 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | {% endblock %} -------------------------------------------------------------------------------- /site/sitemap.xml.gz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wtfutil/wtfdocs/8af8a1a46c81d993d09d1108a04bf493188328d9/site/sitemap.xml.gz -------------------------------------------------------------------------------- /snippets/attributes/_template.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |
5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | {% with name="", desc="Optional ", value="" %} 17 | {% include "attributes/custom.md" %} 18 | {% endwith %} 19 | 20 | 21 | , -------------------------------------------------------------------------------- /snippets/attributes/apikey.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | apiKey 4 |
5 | Your {{ name }} API key. Leave this blank to use the {{ envvar }} environment variable. 6 | 7 | 8 | -------------------------------------------------------------------------------- /snippets/attributes/border.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | border 4 |
5 | Optional Whether or not to draw this widget with a border. Default: 6 | true. 7 | 8 | true, false 9 | -------------------------------------------------------------------------------- /snippets/attributes/colors/background.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | colors.background 4 |
5 | The color to draw the background of the app in. Use this to match your 6 | terminal colors. May be over-written by individual module 7 | configurations. 8 | 9 | Any X11 color name. 10 | -------------------------------------------------------------------------------- /snippets/attributes/colors/border/focusable.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | colors.border.focusable 4 |
5 | The color in which to draw the border of widgets that can accept keyboard focus. 6 | 7 | Any X11 color name. 8 | -------------------------------------------------------------------------------- /snippets/attributes/colors/border/focused.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | colors.border.focused 4 |
5 | The color in which to draw the border of the widget that currently has keyboard focus. 6 | 7 | Any X11 color name. 8 | -------------------------------------------------------------------------------- /snippets/attributes/colors/border/normal.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | colors.border.normal 4 |
5 | The color in which to draw the borders of the widgets that cannot accept focus. 6 | 7 | Any X11 color name. 8 | -------------------------------------------------------------------------------- /snippets/attributes/colors/custom.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | {{ name }} 4 |
5 | {{ desc }} 6 | 7 | 8 | Any X11 color name or long-form hex value (i.e.: 9 | #ff0000). 10 | 11 | -------------------------------------------------------------------------------- /snippets/attributes/colors/highlight.html: -------------------------------------------------------------------------------- 1 | 2 | colors.highlight.fore 3 | The foreground color for the currently-selected row. 4 | Any X11 color name. 5 | 6 | 7 | colors.highlight.back 8 | The background color for the currently-selected row. 9 | Any X11 color name. 10 | -------------------------------------------------------------------------------- /snippets/attributes/colors/highlight.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | colors.highlight.fore 4 |
5 | The foreground color for the currently-selected row. 6 | 7 | 8 | Any X11 color name. 9 | 10 | 11 | 12 | 13 | colors.highlight.back 14 |
15 | The background color for the currently-selected row. 16 | 17 | 18 | Any X11 color name. 19 | 20 | -------------------------------------------------------------------------------- /snippets/attributes/colors/rows.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | colors.rows.even 4 |
5 | The foreground color for even-numbered rows. 6 | 7 | 8 | Any X11 color name. 9 | 10 | 11 | 12 | 13 | colors.rows.odd 14 |
15 | The foreground color for odd-numbered rows. 16 | 17 | 18 | Any X11 color name. 19 | 20 | -------------------------------------------------------------------------------- /snippets/attributes/custom.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | {{ name }} 4 |
5 | {{ desc }} 6 | 7 | {{ value }} 8 | -------------------------------------------------------------------------------- /snippets/attributes/dateFormat.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | dateFormat 4 |
5 | The format to use when rendering date strings. 6 | 7 | 8 | Any valid Go date layout which is handled by Time.Format. 9 | Default: Jan 2. 10 | 11 | -------------------------------------------------------------------------------- /snippets/attributes/email.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | email 4 |
5 | The email address associated with your {{ service }} account. 6 | 7 | A valid email address. 8 | -------------------------------------------------------------------------------- /snippets/attributes/enabled.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | enabled 4 |
5 | Optional Whether or not this module is executed and if its data displayed onscreen. Default: 6 | false. 7 | 8 | true, false 9 | -------------------------------------------------------------------------------- /snippets/attributes/focus_char.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | focusChar 4 |
5 | Optional Define one of the number keys as a shortcut key to access the widget. 6 | 7 | 0..9 8 | -------------------------------------------------------------------------------- /snippets/attributes/focusable.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | focusable 4 |
5 | Optional Whether or not this module accepts keyboard focus. Default: false 6 | 7 | true, false 8 | -------------------------------------------------------------------------------- /snippets/attributes/global/exit_message/display.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | exitMessage.display 4 |
5 | Whether or not to display the WTF text message in the terminal when the app exits. 6 | 7 | true, false 8 | -------------------------------------------------------------------------------- /snippets/attributes/global/exit_message/github_api_key.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | exitMessage.githubAPIKey 4 |
5 | The user's GitHub API key. Used to check against the GitHub API to see if the user is a code contributor or 6 | sponsor. 7 | 8 | Your API key **or** leave it empty to use the `WTF_GITHUB_TOKEN` environment variable. 9 | -------------------------------------------------------------------------------- /snippets/attributes/global/grid/columns.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | grid.columns 4 |
5 | An array that defines the widths of all the columns. 6 | 7 | See tview's Grid for details 8 | 9 | 10 | -------------------------------------------------------------------------------- /snippets/attributes/global/grid/rows.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | grid.rows 4 |
5 | An array that defines the heights of all the rows. 6 | 7 | See tview's Grid for details 8 | -------------------------------------------------------------------------------- /snippets/attributes/global/nav_shortcuts.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | navigation.shortcuts 4 |
5 | Whether or not to display the numeric navigation shortcuts in widget titles. 6 | 7 | true or false 8 | -------------------------------------------------------------------------------- /snippets/attributes/global/open_file_util.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | openFileUtil 4 |
5 | Which local utility to use to open a file or URL. Requires the app to be restarted to take effect. Default: `open`. 6 | 7 | 8 | -------------------------------------------------------------------------------- /snippets/attributes/global/open_url_util.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | opeUrlUtil 4 |
5 | A string sequence used to open URL. If undefined, wtfutil will attempt to open it based on the operating system. 6 | 7 | 8 | -------------------------------------------------------------------------------- /snippets/attributes/global/term.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | term 4 |
5 | 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's default setting. **Note:** If an invalid value is provided for this setting, the app will crash with a `terminal entry not found` error. 6 | 7 | Any valid terminal type (ie: `vt100`, `xterm`, `xterm-256color`, `ansi`, etc.). 8 | -------------------------------------------------------------------------------- /snippets/attributes/hourFormat.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | hourFormat 4 |
5 | Optional The format of the clock. Default: 24. 6 | 7 | 12, 24. 8 | -------------------------------------------------------------------------------- /snippets/attributes/password.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | password 4 |
5 | Your {{ service }} password. {{ pwdesc }} 6 | 7 | 8 | -------------------------------------------------------------------------------- /snippets/attributes/position.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | position 4 |
5 | Defines where in the grid this module's widget will be displayed. 6 | 7 | 8 | -------------------------------------------------------------------------------- /snippets/attributes/refreshInterval.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | refreshInterval 4 |
5 | Optional How often this module will update its data. A positive integer followed by a time unit (ns, us or µs, ms, s, m, h, or nothing which defaults to s). Default: 300s. 6 | 7 | Any valid time duration. 8 | -------------------------------------------------------------------------------- /snippets/attributes/table_header.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | Name 4 | Value 5 | 6 | -------------------------------------------------------------------------------- /snippets/attributes/timezone.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | timezone 4 |
5 | Optional The timezone to display calendar event times in. 6 | Any valid TZ database name. 7 | -------------------------------------------------------------------------------- /snippets/attributes/title.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | title 4 |
5 | Optional The title to display in the widget's onscreen box. 6 | 7 | 8 | 2 | 3 | username 4 |
5 | Your {{ service }} username. {{ undesc }} 6 | 7 | 8 | -------------------------------------------------------------------------------- /snippets/attributes/verifyServerCert.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | verifyServerCertificate 4 |
5 | Whether or not to verify the server's certificate chain and hostname. Default: false. 6 | 7 | true, false 8 | -------------------------------------------------------------------------------- /snippets/attributes/wrapText.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | wrapText 4 |
5 | Optional Whether or not to wrap the text when it hits the widget boundary. Default: true. 6 | 7 | true, false 8 | -------------------------------------------------------------------------------- /snippets/keyboard/a.md: -------------------------------------------------------------------------------- 1 | 2 | a 3 | {{ a }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/arrowBack.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | ← 4 | 5 | {{ arrowback }}{{ arrowBack }} 6 | -------------------------------------------------------------------------------- /snippets/keyboard/arrowDown.md: -------------------------------------------------------------------------------- 1 | 2 | ↓ 3 | Select the next item in the list 4 | -------------------------------------------------------------------------------- /snippets/keyboard/arrowFore.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | → 4 | 5 | {{ arrowfore }}{{ arrowFore }} 6 | -------------------------------------------------------------------------------- /snippets/keyboard/arrowUp.md: -------------------------------------------------------------------------------- 1 | 2 | ↑ 3 | Select the previous item in the list 4 | -------------------------------------------------------------------------------- /snippets/keyboard/b.md: -------------------------------------------------------------------------------- 1 | 2 | b 3 | {{ b }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/c.md: -------------------------------------------------------------------------------- 1 | 2 | c 3 | {{ c }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/ctrlD.md: -------------------------------------------------------------------------------- 1 | 2 | Ctrl-d 3 | Delete the selected item 4 | -------------------------------------------------------------------------------- /snippets/keyboard/ctrlF.md: -------------------------------------------------------------------------------- 1 | 2 | Ctrl-f 3 | {{ ctrlf }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/ctrlJ.md: -------------------------------------------------------------------------------- 1 | 2 | Ctrl-j 3 | {{ ctrlj }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/ctrlK.md: -------------------------------------------------------------------------------- 1 | 2 | Ctrl-k 3 | {{ ctrlk }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/ctrlL.md: -------------------------------------------------------------------------------- 1 | 2 | Ctrl-l 3 | {{ ctrll }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/d.md: -------------------------------------------------------------------------------- 1 | 2 | d 3 | {{ d }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/e.md: -------------------------------------------------------------------------------- 1 | 2 | e 3 | {{ e }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/esc.md: -------------------------------------------------------------------------------- 1 | 2 | [esc] 3 | {{ esc }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/f.md: -------------------------------------------------------------------------------- 1 | 2 | f 3 | {{ f }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/foreslash.md: -------------------------------------------------------------------------------- 1 | 2 | / 3 | Open/close the widget's help modal 4 | -------------------------------------------------------------------------------- /snippets/keyboard/g.md: -------------------------------------------------------------------------------- 1 | 2 | g 3 | {{ g }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/h.md: -------------------------------------------------------------------------------- 1 | 2 | h 3 | {{ h }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/i.md: -------------------------------------------------------------------------------- 1 | 2 | i 3 | {{ i }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/insert.md: -------------------------------------------------------------------------------- 1 | 2 | [insert] 3 | {{ insert }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/j.md: -------------------------------------------------------------------------------- 1 | 2 | j 3 | Select the next item in the list 4 | -------------------------------------------------------------------------------- /snippets/keyboard/k.md: -------------------------------------------------------------------------------- 1 | 2 | k 3 | Select the previous item in the list 4 | -------------------------------------------------------------------------------- /snippets/keyboard/l.md: -------------------------------------------------------------------------------- 1 | 2 | l 3 | {{ l }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/m.md: -------------------------------------------------------------------------------- 1 | 2 | m 3 | {{ m }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/n.md: -------------------------------------------------------------------------------- 1 | 2 | n 3 | {{ n }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/o.md: -------------------------------------------------------------------------------- 1 | 2 | o 3 | {{ o }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/p.md: -------------------------------------------------------------------------------- 1 | 2 | p 3 | {{ p }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/pound.md: -------------------------------------------------------------------------------- 1 | 2 | # 3 | {{ pound }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/q.md: -------------------------------------------------------------------------------- 1 | 2 | q 3 | {{ q }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/questionmark.md: -------------------------------------------------------------------------------- 1 | 2 | ? 3 | {{ questionmark }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/r.md: -------------------------------------------------------------------------------- 1 | 2 | r 3 | Refresh the data 4 | -------------------------------------------------------------------------------- /snippets/keyboard/return.md: -------------------------------------------------------------------------------- 1 | 2 | [return] 3 | {{ return }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/s.md: -------------------------------------------------------------------------------- 1 | 2 | s 3 | {{ s }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/space.md: -------------------------------------------------------------------------------- 1 | 2 | [space] 3 | {{ space }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/spacer.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | -------------------------------------------------------------------------------- /snippets/keyboard/t.md: -------------------------------------------------------------------------------- 1 | 2 | t 3 | {{ t }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/table_header.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | Key 4 | Action 5 | 6 | -------------------------------------------------------------------------------- /snippets/keyboard/u.md: -------------------------------------------------------------------------------- 1 | 2 | u 3 | {{ u }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/v.md: -------------------------------------------------------------------------------- 1 | 2 | v 3 | {{ v }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/w.md: -------------------------------------------------------------------------------- 1 | 2 | w 3 | {{ w }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/x.md: -------------------------------------------------------------------------------- 1 | 2 | x 3 | {{ x }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/y.md: -------------------------------------------------------------------------------- 1 | 2 | y 3 | {{ y }} 4 | -------------------------------------------------------------------------------- /snippets/keyboard/z.md: -------------------------------------------------------------------------------- 1 | 2 | z 3 | {{ z }} 4 | -------------------------------------------------------------------------------- /snippets/src_path.md: -------------------------------------------------------------------------------- 1 | ## Source Code 2 | 3 | [https://github.com/wtfutil/wtf/tree/master/modules/{{ src }}](https://github.com/wtfutil/wtf/tree/master/modules/{{ src }}) -------------------------------------------------------------------------------- /snippets/test.md: -------------------------------------------------------------------------------- 1 | Hello 2 | YO! --------------------------------------------------------------------------------