wtf/_site/content/getting_started/_index.md

title, date, draft, weight

title	date	draft	weight
Getting Started	2018-05-21T16:11:58-07:00	false	1

Quick Start

1. Download the stand-alone, compiled binary.
2. Unzip the downloaded file.
3. From the command line, cd into the newly-created /wtf directory.
4. From the command line, run the app: ./wtf

This should launch the app in your terminal using the default simple configuration. See Configuration for more details.

Command-line Options

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

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

--module, -m
Shows help information for the specific named module, if that module supports help text.
Example: wtf --module=todo.

--version, -v
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).