1
0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00
wtf/_site/content/posts/overview.md
2018-05-22 21:34:23 -07:00

1.7 KiB

title, date, draft
title date draft
Overview 2018-05-21T16:11:58-07:00 false

WTF is a personal information dashboard for your terminal, developed for those who spend most of their day in the command line.

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.

Download it as a stand-alone, compiled binary, or install it from source.

Once installed, edit your configuration file and define the modules you want to run.

Configuration instructions for each module can be found in the module pages, listed at left.

Command-line Options

--config
Allows you to define a custom config file to use. See Configuration for more details.

-h
Shows help information for the command-line arguments that WTF takes.

--help [module name]
Shows help information for the specific named module, if that module supports help text. Ex: wtf --help git.

--version
Shows version info.

Keyboard Commands

Key: Ctrl-R
Action: Force-refresh the data for all modules.

Key: Esc
Action: Unfocus the currently-focused widget.

Key: Tab
Action: Move between focusable modules (Shift-Tab to move backwards).