How to Install and Get Started with WTF (wtfutil.com)

Updated

WTF is a personal information dashboard that runs in your terminal. To get started, follow the official docs in this order: Getting Started → Quick Start → Installation → Configuration. Installation depends on your platform and package method, and you'll need a configuration file before modules appear on screen. The site's own navigation treats Getting Started as the entry point, so start there rather than jumping straight to module pages.

What WTF is and what you need first

WTF (wtfutil.com) is described on the site as "the personal information dashboard for your terminal." It aggregates data from many sources—services like GitHub, Jira, Kubernetes, weather, stocks, and more—into a single terminal view.

Before installing, confirm:

  • You have a working terminal on your platform (the docs separate installation by platform and package method, so check which applies to you).
  • You know where your configuration file will live. The docs have a dedicated Configuration Files page plus Global Settings and Common Settings pages.
  • You've looked at the Glossary if terms like "grid layout" or "module" are unfamiliar.

Step-by-step: install and first run

  1. Open the Getting Started page. This is the recommended entry point in the site navigation and orients you before any commands.
  2. Read Quick Start. It gives the shortest path to a running dashboard.
  3. Follow Installation for your platform and package method. The docs list installation as its own section because the steps differ by platform; use the variant that matches your setup rather than mixing instructions.
  4. Create or review your configuration file. The Configuration section covers configuration files, global settings, common settings, and grid layout. Modules only appear once they're configured, so expect an empty or minimal dashboard until this is done.
  5. Launch WTF in your terminal. After configuration, the dashboard renders according to your grid layout.
  6. Add modules incrementally. The Modules section lists each supported integration (Airbrake, Asana, Azure DevOps, GitHub, Jira, Kubernetes, Weather, and many others). Add one or two first, confirm they render, then expand.

Expected result: a terminal dashboard showing the modules you configured, arranged per your grid layout.

Verify it worked

  • The dashboard starts without configuration errors.
  • Each configured module displays data rather than an error state.
  • Layout matches what you defined in the grid layout settings.

If a module shows nothing, recheck that module's entry in your configuration file and its required settings on the module's docs page.

Common sticking points

  • Blank dashboard on first run: almost always a missing or incomplete configuration file. Revisit Configuration Files and Global Settings.
  • Wrong install instructions: installation varies by platform and package method; confirm you're on the right variant.
  • Module not appearing: check the specific module page under Modules—each has its own settings.
  • Layout looks wrong: review the Grid Layout page under Configuration.

Removing WTF

The docs include an Uninstallation page alongside Installation. Use it if you want to remove WTF cleanly rather than deleting files manually.

Where to go next

  • Modules — browse the full list and pick integrations relevant to your work.
  • Development → Creating New Modules — if you want to build your own.
  • Sponsoring and Support — the site's support entry point if you hit issues the docs don't cover.

Start with Getting Started and Quick Start, install for your platform, configure before launching, then add modules one at a time.