mirror of
https://github.com/taigrr/wtf
synced 2025-01-18 04:03:14 -08:00
530 lines
17 KiB
HTML
530 lines
17 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<title>WTF - the terminal dashboard</title>
|
|
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
|
|
<meta name="generator" content="Hugo 0.38.2" />
|
|
<title>Overview :: WTF - the terminal dashboard</title>
|
|
<link rel="shortcut icon" href="/images/favicon.png" type="image/x-icon" />
|
|
<link href="/css/font-awesome.min.css" rel="stylesheet">
|
|
<link href="/css/nucleus.css" rel="stylesheet">
|
|
<link href="/theme-flex/style.css" rel="stylesheet">
|
|
|
|
<link rel="stylesheet" href="/css/bootstrap.min.css">
|
|
<script src="/js/jquery-2.x.min.js"></script>
|
|
<script type="text/javascript">
|
|
var baseurl = "\/";
|
|
</script>
|
|
<meta name="description" content="">
|
|
|
|
|
|
|
|
|
|
</head>
|
|
<body data-url="/posts/overview/">
|
|
|
|
<header>
|
|
<div class="logo">
|
|
|
|
|
|
|
|
<a class="baselink" href="/">WTF - the terminal dashboard</a>
|
|
|
|
|
|
</div>
|
|
<div class="burger"><a href="javascript:void(0);" style="font-size:15px;">☰</a></div>
|
|
<nav class="shortcuts">
|
|
<li class="" role="">
|
|
<a href="https://github.com/senorprogrammer/wtf" rel="noopener">
|
|
<i class='fa fa-github'></i> <label>WTF on Github</label>
|
|
</a>
|
|
</li>
|
|
<li class="" role="">
|
|
<a href="https://github.com/senorprogrammer/wtf/releases" rel="noopener">
|
|
<i class='fa fa-cloud-download'></i> <label>Download WTF</label>
|
|
</a>
|
|
</li>
|
|
<li class="" role="">
|
|
<a href="https://github.com/senorprogrammer/wtf/blob/master/README.md" rel="noopener">
|
|
<i class='fa fa-bullhorn'></i> <label>Credits</label>
|
|
</a>
|
|
</li>
|
|
</nav>
|
|
</header>
|
|
<article>
|
|
<aside>
|
|
<ul class="menu">
|
|
<li data-nav-id="/" class="dd-item">
|
|
<a href="/">
|
|
<i class="fa fa-fw fa-home"></i>
|
|
</a>
|
|
</li>
|
|
<li data-nav-id="/posts/" class="dd-item parent haschildren
|
|
">
|
|
<div>
|
|
<a href="/posts/">Posts</a>
|
|
<i class="fa fa-angle-down fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
<ul>
|
|
<li data-nav-id="/posts/modules/twitter/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/twitter/">
|
|
Twitter
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/zendesk/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/zendesk/">
|
|
Zendesk
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/travisci/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/travisci/">
|
|
TravisCI
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/todoist/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/todoist/">
|
|
Todoist
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/gerrit/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/gerrit/">
|
|
Gerrit
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/logger/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/logger/">
|
|
Logger
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/cryptocurrencies/blockfolio/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/cryptocurrencies/blockfolio/">
|
|
Blockfolio
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/ipapi/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/ipapi/">
|
|
IP-API
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/circleci/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/circleci/">
|
|
CircleCI
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/gspreadsheet/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/gspreadsheet/">
|
|
Google Spreadsheets
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/jenkins/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/jenkins/">
|
|
Modules: Jenkins
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/gitlab/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/gitlab/">
|
|
GitLab
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/cryptocurrencies/bittrex/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/cryptocurrencies/bittrex/">
|
|
Bittrex
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/cryptocurrencies/cryptolive/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/cryptocurrencies/cryptolive/">
|
|
CryptoLive
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/prettyweather/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/prettyweather/">
|
|
Pretty Weather
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/ipinfo/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/ipinfo/">
|
|
IPInfo
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/power/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/power/">
|
|
Power
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/configuration/iterm2/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/configuration/iterm2/">
|
|
Configuration: iTerm2
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/overview/" class="dd-item active">
|
|
<div>
|
|
<a href="/posts/overview/">
|
|
Overview
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/installation/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/installation/">
|
|
Installation
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/cmdrunner/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/cmdrunner/">
|
|
CmdRunner
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/configuration/attributes/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/configuration/attributes/">
|
|
Configuration: Attributes
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/todo/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/todo/">
|
|
Todo
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/jira/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/jira/">
|
|
Jira
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/trello/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/trello/">
|
|
Trello
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/gcal/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/gcal/">
|
|
Google Calendar
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/github/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/github/">
|
|
GitHub
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/git/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/git/">
|
|
Git
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/weather/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/weather/">
|
|
Weather
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/textfile/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/textfile/">
|
|
Textfile
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/newrelic/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/newrelic/">
|
|
New Relic
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/opsgenie/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/opsgenie/">
|
|
OpsGenie
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/security/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/security/">
|
|
Security
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/bamboohr/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/bamboohr/">
|
|
BambooHR
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/clocks/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/clocks/">
|
|
Clocks
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/">
|
|
Modules
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/glossary/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/glossary/">
|
|
Glossary
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/configuration/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/configuration/">
|
|
Configuration
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
<section>
|
|
</section>
|
|
</aside>
|
|
<section class="page">
|
|
|
|
<div class="nav-select">
|
|
<center>Navigation :
|
|
<select onchange="javascript:location.href = this.value;">
|
|
|
|
<option value="/posts/" >
|
|
Posts</option>
|
|
<option value="/posts/modules/twitter/" >- Twitter</option>
|
|
<option value="/posts/modules/zendesk/" >- Zendesk</option>
|
|
<option value="/posts/modules/travisci/" >- TravisCI</option>
|
|
<option value="/posts/modules/todoist/" >- Todoist</option>
|
|
<option value="/posts/modules/gerrit/" >- Gerrit</option>
|
|
<option value="/posts/modules/logger/" >- Logger</option>
|
|
<option value="/posts/modules/cryptocurrencies/blockfolio/" >- Blockfolio</option>
|
|
<option value="/posts/modules/ipapi/" >- IP-API</option>
|
|
<option value="/posts/modules/circleci/" >- CircleCI</option>
|
|
<option value="/posts/modules/gspreadsheet/" >- Google Spreadsheets</option>
|
|
<option value="/posts/modules/jenkins/" >- Modules: Jenkins</option>
|
|
<option value="/posts/modules/gitlab/" >- GitLab</option>
|
|
<option value="/posts/modules/cryptocurrencies/bittrex/" >- Bittrex</option>
|
|
<option value="/posts/modules/cryptocurrencies/cryptolive/" >- CryptoLive</option>
|
|
<option value="/posts/modules/prettyweather/" >- Pretty Weather</option>
|
|
<option value="/posts/modules/ipinfo/" >- IPInfo</option>
|
|
<option value="/posts/modules/power/" >- Power</option>
|
|
<option value="/posts/configuration/iterm2/" >- Configuration: iTerm2</option>
|
|
<option value="/posts/overview/" selected>- Overview</option>
|
|
<option value="/posts/installation/" >- Installation</option>
|
|
<option value="/posts/modules/cmdrunner/" >- CmdRunner</option>
|
|
<option value="/posts/configuration/attributes/" >- Configuration: Attributes</option>
|
|
<option value="/posts/modules/todo/" >- Todo</option>
|
|
<option value="/posts/modules/jira/" >- Jira</option>
|
|
<option value="/posts/modules/trello/" >- Trello</option>
|
|
<option value="/posts/modules/gcal/" >- Google Calendar</option>
|
|
<option value="/posts/modules/github/" >- GitHub</option>
|
|
<option value="/posts/modules/git/" >- Git</option>
|
|
<option value="/posts/modules/weather/" >- Weather</option>
|
|
<option value="/posts/modules/textfile/" >- Textfile</option>
|
|
<option value="/posts/modules/newrelic/" >- New Relic</option>
|
|
<option value="/posts/modules/opsgenie/" >- OpsGenie</option>
|
|
<option value="/posts/modules/security/" >- Security</option>
|
|
<option value="/posts/modules/bamboohr/" >- BambooHR</option>
|
|
<option value="/posts/modules/clocks/" >- Clocks</option>
|
|
<option value="/posts/modules/" >- Modules</option>
|
|
<option value="/posts/glossary/" >- Glossary</option>
|
|
<option value="/posts/configuration/" >- Configuration</option>
|
|
|
|
|
|
|
|
|
|
</select>
|
|
</center>
|
|
</div>
|
|
<div>
|
|
<div class="searchbox">
|
|
<input data-search-input id="search-by" type="text" placeholder="Search...">
|
|
</div>
|
|
<script type="text/javascript" src="/js/lunr.min.js"></script>
|
|
<script type="text/javascript" src="/js/auto-complete.js"></script>
|
|
<link href="/css/auto-complete.css" rel="stylesheet">
|
|
<script type="text/javascript">
|
|
|
|
var baseurl = "\/";
|
|
|
|
</script>
|
|
<script type="text/javascript" src="/js/search.js"></script>
|
|
</div>
|
|
|
|
|
|
<h1>Overview</h1>
|
|
|
|
|
|
|
|
|
|
|
|
<p><span style="font-family: monospace; font-size: 1.6em;">WTF</span> is a personal information dashboard for your terminal, developed for those who spend most of their day in the command line.</p>
|
|
|
|
<p>It allows you to monitor services and systems that you otherwise might
|
|
keep browser tabs open for, the kinds of things you don’t always need
|
|
visible, but might check in on every now and then.</p>
|
|
|
|
<h2 id="quick-start">Quick Start</h2>
|
|
|
|
<ol>
|
|
<li><a href="https://github.com/senorprogrammer/wtf/releases">Download</a> the stand-alone, compiled binary.</li>
|
|
<li>Unzip the downloaded file.</li>
|
|
<li>From the command line, <code>cd</code> into the newly-created <code>/wtf</code> directory.</li>
|
|
<li>From the command line, run the app: <code>./wtf</code></li>
|
|
</ol>
|
|
|
|
<p>This should launch the app in your terminal using the default simple
|
|
configuration. See <a href="/posts/configuration/">Configuration</a> for
|
|
more details.</p>
|
|
|
|
<h2 id="command-line-options">Command-line Options</h2>
|
|
|
|
<p><code>--config, -c</code> <br />
|
|
Allows you to define a custom config file to use. See <a href="/posts/configuration/">Configuration</a> for more details.</p>
|
|
|
|
<p><code>--help, -h</code> <br />
|
|
Shows help information for the command-line arguments that WTF
|
|
takes.</p>
|
|
|
|
<p><code>--module, -m</code> <br />
|
|
Shows help information for the specific named module, if that module
|
|
supports help text. <br />
|
|
Example: <code>wtf --module=todo</code>.</p>
|
|
|
|
<p><code>--version, -v</code> <br />
|
|
Shows version info.</p>
|
|
|
|
<h2 id="keyboard-commands">Keyboard Commands</h2>
|
|
|
|
<p><span class="caption">Key:</span> <code>Ctrl-R</code> <br />
|
|
<span class="caption">Action:</span> Force-refresh the data for all modules.</p>
|
|
|
|
<p><span class="caption">Key:</span> <code>Esc</code> <br />
|
|
<span class="caption">Action:</span> Unfocus the currently-focused
|
|
widget.</p>
|
|
|
|
<p><span class="caption">Key:</span> <code>Tab</code> <br />
|
|
<span class="caption">Action:</span> Move between focusable modules (<code>Shift-Tab</code> to move backwards).</p>
|
|
|
|
|
|
|
|
|
|
<div class="chevrons">
|
|
<div id="navigation">
|
|
<a class="nav nav-prev" href="/posts/configuration/iterm2/" title="Configuration: iTerm2"> <i class="fa fa-chevron-left"></i><label>Configuration: iTerm2</label></a>
|
|
<a class="nav nav-next" href="/posts/installation/" title="Installation" style="margin-right: 0px;"><label>Installation</label><i class="fa fa-chevron-right"></i></a></div>
|
|
</div>
|
|
|
|
</section>
|
|
</article>
|
|
|
|
<footer>
|
|
|
|
<div class="footline">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="date">
|
|
<i class='fa fa-calendar'></i> Last update on 21/05/2018
|
|
</div>
|
|
|
|
|
|
<div class="github-link">
|
|
<a href="https://github.com/vjeantet/hugo-theme-docdock/edit/master/exampleSite/content/posts/overview.md" target="blank"><i class="fa fa-code-fork"></i>
|
|
Improve this page</a>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div>
|
|
|
|
|
|
|
|
Create a content/_footer.md file to customize the footer content
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</footer>
|
|
|
|
<script src="/js/clipboard.min.js"></script>
|
|
|
|
<link href="/css/featherlight.min.css" rel="stylesheet">
|
|
<script src="/js/featherlight.min.js"></script>
|
|
|
|
|
|
|
|
<script src="/theme-flex/script.js"></script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</body>
|
|
</html> |