mirror of
https://github.com/taigrr/wtf
synced 2025-01-18 04:03:14 -08:00
176 lines
7.3 KiB
HTML
176 lines
7.3 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en-us" class="wf-firasans-n4-active wf-active">
|
|
<head>
|
|
<link href="http://gmpg.org/xfn/11" rel="profile">
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<!-- Enable responsiveness on mobile devices -->
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
|
|
|
|
|
<meta name="generator" content="Hugo 0.38.2" />
|
|
|
|
<title>Overview | WTF - A Terminal Dashboard</title>
|
|
<meta content="Overview - WTF - A Terminal Dashboard" property="og:title">
|
|
<meta content=" - " property="og:description">
|
|
<!-- CSS -->
|
|
<link rel="stylesheet" href="//cdn.rawgit.com/milligram/milligram/master/dist/milligram.min.css">
|
|
<link href="https://fonts.googleapis.com/css?family=Fira+Sans:300,300i,400,400i|Roboto+Mono:300,300i,400,400i" rel="stylesheet">
|
|
<link rel="stylesheet" href="https://wtfutil.com/css/print.css" media="print">
|
|
<link rel="stylesheet" href="https://wtfutil.com/css/poole.css">
|
|
<link rel="stylesheet" href="https://wtfutil.com/css/hyde.css">
|
|
<link rel="stylesheet" href="https://wtfutil.com/css/syntax.css">
|
|
<link rel="stylesheet" href="https://wtfutil.com/css/wtf.css">
|
|
<!-- Font-Awesome -->
|
|
<script defer src="https://use.fontawesome.com/releases/v5.0.9/js/all.js" integrity="sha384-8iPTk2s/jMVj81dnzb/iFR2sdA7u06vHJyyLlAd4snFpCl/SnyUjRrbdJsw1pGIl" crossorigin="anonymous"></script>
|
|
|
|
<!-- Customised CSS -->
|
|
<link rel="stylesheet" href="https://wtfutil.com/css/custom.css">
|
|
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
|
|
<!--[if lt IE 9]>
|
|
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
|
|
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
|
<![endif]-->
|
|
<!-- Icons -->
|
|
<link rel="apple-touch-icon-precomposed" sizes="144x144" href="/apple-touch-icon-144-precomposed.png">
|
|
<link rel="shortcut icon" href="/favicon.png">
|
|
|
|
<script async defer src="https://buttons.github.io/buttons.js"></script>
|
|
|
|
</head>
|
|
<body>
|
|
<div class="sidebar">
|
|
<div class="container">
|
|
<div class="sidebar-about text-center">
|
|
|
|
<a href="https://wtfutil.com/"> <img src="/img/wtf.png" alt="WFT Logo" class="" width=""> </a>
|
|
<p class="lead">
|
|
|
|
</p>
|
|
</div>
|
|
|
|
<div>
|
|
<h3 style="color: white;">Content</h3>
|
|
|
|
<ul style="list-style-type: none;">
|
|
<li class="sidebar-list-item-1"><a href="/posts/overview/">Overview</a></li>
|
|
<li class="sidebar-list-item-1"><a href="/posts/installation/">Installation</a></li>
|
|
<li class="sidebar-list-item-1"><a href="/posts/configuration/">Configuration</a></li>
|
|
<li class="sidebar-list-item-2"><a href="/posts/configuration/attributes/">Attributes</a></li>
|
|
<li class="sidebar-list-item-2"><a href="/posts/configuration/iterm2/">iTerm2</a></li>
|
|
<li class="sidebar-list-item-1"><a href="https://github.com/senorprogrammer/wtf/releases">Releases</a></li>
|
|
</ul>
|
|
|
|
<ul style="list-style-type: none;">
|
|
<li class="sidebar-list-item-1"><a href="/posts/modules/">Modules</a></li>
|
|
<li class="sidebar-list-item-2"><a href="/posts/modules/bamboohr/">BambooHR</a></li>
|
|
<li class="sidebar-list-item-2"><a href="/posts/modules/cryptocurrencies/bittrex/">Bittrex</a></li>
|
|
<li class="sidebar-list-item-2"><a href="/posts/modules/clocks/">Clocks</a></li>
|
|
<li class="sidebar-list-item-2"><a href="/posts/modules/cryptocurrencies/cryptolive/">CryptoLive</a></li>
|
|
<li class="sidebar-list-item-2"><a href="/posts/modules/cmdrunner/">CmdRunner</a></li>
|
|
<li class="sidebar-list-item-2"><a href="/posts/modules/git/">Git</a></li>
|
|
<li class="sidebar-list-item-2"><a href="/posts/modules/github/">GitHub</a></li>
|
|
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
|
|
<li class="sidebar-list-item-2"><a href="/posts/modules/ipinfo/">IPInfo</a></li>
|
|
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">Jira</a></li>
|
|
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/">New Relic</a></li>
|
|
<li class="sidebar-list-item-2"><a href="/posts/modules/opsgenie/">OpsGenie</a></li>
|
|
<li class="sidebar-list-item-2"><a href="/posts/modules/power/">Power</a></li>
|
|
<li class="sidebar-list-item-2"><a href="/posts/modules/prettyweather/">PrettyWeather <span title="experimental">🔬</span></a></li>
|
|
<li class="sidebar-list-item-2"><a href="/posts/modules/security/">Security</a></li>
|
|
<li class="sidebar-list-item-2"><a href="/posts/modules/textfile/">Text File</a></li>
|
|
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/">Todo</a></li>
|
|
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/">Weather</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<p class="copyright">
|
|
© 2018 Chris Cummer.
|
|
<br />
|
|
<a href="https://creativecommons.org/licenses/by/4.0">Some Rights Reserved</a>.
|
|
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="content container">
|
|
<div class="post">
|
|
<h1>Overview</h1>
|
|
|
|
<div class="col-sm-12 col-md-12">
|
|
<span class="text-left post-date meta">
|
|
|
|
|
|
May 21, 2018
|
|
|
|
|
|
|
|
|
|
<br/>
|
|
|
|
</span>
|
|
</div>
|
|
|
|
|
|
|
|
<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>
|
|
|
|
<div class="footer">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</body>
|
|
</html>
|