taigrr/wtf
1
0
Fork 0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00
Code Issues Projects Releases Wiki Activity
wtf/docs/getting_started/index.html

537 lines
16 KiB
HTML
Raw Blame History

<!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.46" />
<title>Getting Started :: 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 = "https:\/\/wtfutil.com\/";
</script>
<meta name="description" content="">
<link rel="stylesheet" href="/css/custom.css">
</head>
<body data-url="/getting_started/">
<header>
<div class="logo">
<a class="baselink" href="https://wtfutil.com/">WTF - the terminal dashboard</a>
</div>
<div class="burger"><a href="javascript:void(0);" style="font-size:15px;">&#9776;</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#contributors" 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="/getting_started/" class="dd-item parent active haschildren
">
<div>
<a href="/getting_started/">Getting Started</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="/getting_started/installation/" class="dd-item">
<div>
<a href="/getting_started/installation/">
Installation
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/getting_started/glossary/" class="dd-item">
<div>
<a href="/getting_started/glossary/">
Glossary
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li>
<li data-nav-id="/configuration/" class="dd-item haschildren
">
<div>
<a href="/configuration/">Configuration</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/configuration/attributes/" class="dd-item">
<div>
<a href="/configuration/attributes/">
Attributes
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/configuration/iterm2/" class="dd-item">
<div>
<a href="/configuration/iterm2/">
iTerm2
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li>
<li data-nav-id="/modules/" class="dd-item haschildren
">
<div>
<a href="/modules/">Modules</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/bamboohr/" class="dd-item">
<div>
<a href="/modules/bamboohr/">
BambooHR
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/circleci/" class="dd-item">
<div>
<a href="/modules/circleci/">
CircleCI
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/clocks/" class="dd-item">
<div>
<a href="/modules/clocks/">
Clocks
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/cmdrunner/" class="dd-item">
<div>
<a href="/modules/cmdrunner/">
CmdRunner
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/cryptocurrencies/" class="dd-item haschildren
">
<div>
<a href="/modules/cryptocurrencies/">Crypo Currencies</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/cryptocurrencies/bittrex/" class="dd-item">
<div>
<a href="/modules/cryptocurrencies/bittrex/">
Bittrex
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/cryptocurrencies/blockfolio/" class="dd-item">
<div>
<a href="/modules/cryptocurrencies/blockfolio/">
Blockfolio
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/cryptocurrencies/cryptolive/" class="dd-item">
<div>
<a href="/modules/cryptocurrencies/cryptolive/">
CryptoLive
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li>
<li data-nav-id="/modules/gerrit/" class="dd-item">
<div>
<a href="/modules/gerrit/">
Gerrit
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/git/" class="dd-item">
<div>
<a href="/modules/git/">
Git
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/github/" class="dd-item">
<div>
<a href="/modules/github/">
GitHub
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/gitlab/" class="dd-item">
<div>
<a href="/modules/gitlab/">
GitLab
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/gitter/" class="dd-item">
<div>
<a href="/modules/gitter/">
Gitter
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/google/" class="dd-item haschildren
">
<div>
<a href="/modules/google/">Google Apps</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/google/gcal/" class="dd-item">
<div>
<a href="/modules/google/gcal/">
Google Calendar
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/google/gspreadsheet/" class="dd-item">
<div>
<a href="/modules/google/gspreadsheet/">
Google Spreadsheets
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li>
<li data-nav-id="/modules/hackernews/" class="dd-item">
<div>
<a href="/modules/hackernews/">
Hacker News
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/ipaddress/" class="dd-item haschildren
">
<div>
<a href="/modules/ipaddress/">IP Addresses</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/ipaddress/ipapi/" class="dd-item">
<div>
<a href="/modules/ipaddress/ipapi/">
IP-API
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/ipaddress/ipinfo/" class="dd-item">
<div>
<a href="/modules/ipaddress/ipinfo/">
IPInfo
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li>
<li data-nav-id="/modules/jenkins/" class="dd-item">
<div>
<a href="/modules/jenkins/">
Jenkins
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/jira/" class="dd-item">
<div>
<a href="/modules/jira/">
Jira
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/logger/" class="dd-item">
<div>
<a href="/modules/logger/">
Logger
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/newrelic/" class="dd-item">
<div>
<a href="/modules/newrelic/">
New Relic
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/opsgenie/" class="dd-item">
<div>
<a href="/modules/opsgenie/">
OpsGenie
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/power/" class="dd-item">
<div>
<a href="/modules/power/">
Power
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/security/" class="dd-item">
<div>
<a href="/modules/security/">
Security
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/textfile/" class="dd-item">
<div>
<a href="/modules/textfile/">
Textfile
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/todo/" class="dd-item">
<div>
<a href="/modules/todo/">
Todo
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/todoist/" class="dd-item">
<div>
<a href="/modules/todoist/">
Todoist
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/travisci/" class="dd-item">
<div>
<a href="/modules/travisci/">
TravisCI
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/trello/" class="dd-item">
<div>
<a href="/modules/trello/">
Trello
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/twitter/" class="dd-item">
<div>
<a href="/modules/twitter/">
Twitter
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/weather_services/" class="dd-item haschildren
">
<div>
<a href="/modules/weather_services/">Weather Services</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/weather_services/prettyweather/" class="dd-item">
<div>
<a href="/modules/weather_services/prettyweather/">
Pretty Weather
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/weather_services/weather/" class="dd-item">
<div>
<a href="/modules/weather_services/weather/">
Weather
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li>
<li data-nav-id="/modules/zendesk/" class="dd-item">
<div>
<a href="/modules/zendesk/">
Zendesk
</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="/getting_started/" selected>
Getting Started</option>
<option value="/getting_started/installation/" >- Installation</option>
<option value="/getting_started/glossary/" >- Glossary</option>
<option value="/configuration/" >
Configuration</option>
<option value="/modules/" >
Modules</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 = "https:\/\/wtfutil.com\/";
</script>
<script type="text/javascript" src="/js/search.js"></script>
</div>
<h1>Getting Started</h1>
<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="/" title="WTF"> <i class="fa fa-chevron-left"></i><label>WTF</label></a>
<a class="nav nav-next" href="/getting_started/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/getting_started/_index.md" target="blank"><i class="fa fa-code-fork"></i>
Improve this page</a>
</div>
</div>
<div>
</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>
Reference in New Issue View Git Blame Copy Permalink