You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Chris Cummer 1686c9a6a9 Add small_config.yml for testing 4 hours ago
.github Update FUNDING.yml 1 month ago
_sample_configs Add small_config.yml for testing 4 hours ago
app WTF-484 DigitalOcean module (#782) 15 hours ago
cfg IPInfo styling (#744) 1 month ago
checklist WTF-657 Add spec coverage for cfg/common_settings.go (#728) 1 month ago
flags WTF-657 Add spec coverage for cfg/common_settings.go (#728) 1 month ago
generator Reimpliments the module configuration validation 5 months ago
help Fix help for modules 4 months ago
images New header logo 1 month ago
logger WTF-657 Add spec coverage for cfg/common_settings.go (#728) 1 month ago
modules WTF-784 Fix CmdRunner title spacing issue (#785) 5 hours ago
scripts Update goproxy to default proxy.golang.org 1 month ago
utils Add small_config.yml for testing 4 hours ago
vendor Integrate vendored NewRelic dependency (#767) 1 week ago
view WTF-484 DigitalOcean module (#782) 15 hours ago
wtf WTF-484 DigitalOcean module (#782) 15 hours ago
.all-contributorsrc Add @liyiheng as a contributor 10 hours ago
.codeclimate.yml Fix invalid .codeclimate.yml 1 year ago
.editorconfig Minor git tweaks 1 year ago
.gitattributes Update .gitattributes 1 year ago
.gitignore .vscode dir into .gitignore 7 months ago
.gitmodules Delete the docdock theme submodule 1 year ago
.goreleaser.yml Update goproxy to default proxy.golang.org 1 month ago
.travis.yml Remove go 1.12 support (goproxy syntax issue) 1 month ago
CHANGELOG.md Update CHANGELOG.md 11 hours ago
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 1 year ago
CONTRIBUTING.md New header logo 1 month ago
Dockerfile Update goproxy to default proxy.golang.org 1 month ago
LICENSE.md Change license to MPL v2 1 year ago
Makefile Improve the Makefile 10 hours ago
README.md Add @liyiheng as a contributor 10 hours ago
go.mod WTF-484 DigitalOcean module (#782) 15 hours ago
go.sum WTF-484 DigitalOcean module (#782) 15 hours ago
main.go Add new urlutil option, and have these be reloadable 2 months ago

README.md

WTF

All Contributors Travis Status Go Report Card Twitter

WTF (aka ‘wtfutil’) is the personal information dashboard for your terminal, providing at-a-glance access to your very important but infrequently-needed stats and data.

Used by thousands of developers and tech people around the world, WTF is free and open-source. To support the continued use and development of WTF, please consider sponsoring WTF via GitHub Sponsors.

Installation

Installing via Homebrew

The simplest way from Homebrew:

brew install wtfutil

wtfutil

That version can sometimes lag a bit, as recipe updates take time to get accepted into homebrew-core. If you always want the bleeding edge of releases, you can tap it:

brew tap wtfutil/wtfutil
brew install wtfutil

wtfutil

Installing via MacPorts

You can also install via MacPorts:

sudo port selfupdate
sudo port install wtfutil

wtfutil

Installing via Scarf

You can also install via Scarf:

scarf install wtfutil

wtfutil

Installing a Binary

Download the latest binary from GitHub.

WTF is a stand-alone binary. Once downloaded, copy it to a location you can run executables from (ie: /usr/local/bin/), and set the permissions accordingly:

chmod a+x /usr/local/bin/wtfutil

and you should be good to go.

Installing from Source

If you want to run the build command from within your $GOPATH:

# Set the Go proxy
export GOPROXY="https://proxy.golang.org,direct"

# Disable the Go checksum database
export GOSUMDB=off

# Enable Go modules
export GO111MODULE=on

go get -u github.com/wtfutil/wtf
cd $GOPATH/src/github.com/wtfutil/wtf
make install
make run

If you want to run the build command from a folder that is not in your $GOPATH:

# Set the Go proxy
export GOPROXY="https://proxy.golang.org,direct"

go get -u github.com/wtfutil/wtf
cd $GOPATH/src/github.com/wtfutil/wtf
make install
make run

Note: WTF is only compatible with Go versions 1.12.0 or later (due to the use of Go modules and newer standard library functions). If you would like to use gccgo to compile, you must use gccgo-9 or later which introduces support for Go modules.

Running via Docker

You can run wtf inside a docker container:

# download the source
git clone https://github.com/wtfutil/wtf

# build the docker container
docker build -t wtfutil .

# run the container
docker run -it wtfutil

Communication

Slack

If you’re a member of the Gophers Slack community (https://invite.slack.golangbridge.org) there’s a WTFUtil channel you should join for all your WTF questions, development conversations, etc.

Find #wtfutil on https://gophers.slack.com/ and join us.

Twitter

Also, follow on Twitter for news and latest updates.

Documentation

See https://wtfutil.com for the definitive documentation. Here’s some short-cuts:

Modules

Modules are the chunks of functionality that make WTF useful. Modules are added and configured by including their configuration values in your config.yml file. The documentation for each module describes how to configure them.

Some interesting modules you might consider adding to get you started:

Getting Bugs Fixed or Features Added

WTF is open-source software, informally maintained by a small collection of volunteers who come and go at their leisure. There are absolutely no guarantees that, even if an issue is opened for them, bugs will be fixed or features added.

If there is a bug that you really need to have fixed or a feature you really want to have implemented, you can greatly increase your chances of that happening by creating a bounty on BountySource to provide an incentive for someone to tackle it.

Contributing to the Source Code

First, kindly read Talk, then code by Dave Cheney. It’s great advice and will often save a lot of time and effort.

Next, kindly read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

Then create your branch, write your code, submit your PR, and join the rest of the awesome people who’ve contributed their time and effort towards WTF. Without their contributors, WTF wouldn’t be possible.

Don’t worry if you’ve never written Go before, or never contributed to an open source project before, or that your code won’t be good enough. For a surprising number of people WTF has been their first Go project, or first open source contribution. If you’re here, and you’ve read this far, you’re the right stuff.

Contributing to the Documentation

Documentation now lives in its own repository here: https://github.com/wtfutil/wtfdocs.

Please make all additions and updates to documentation in that repository.

Adding Dependencies

Dependency management in WTF is handled by Go modules. Please check out that page for more details on how Go modules work.

Contributors

Chris Cummer
Chris Cummer

Anand Sudhir Prayaga
Anand Sudhir Prayaga

Hossein Mehrabi
Hossein Mehrabi

FengYa
FengYa

deltax
deltax

Bill Keenan
Bill Keenan

June S
June S

liyiheng
liyiheng

baustinanki
baustinanki

lucus lee
lucus lee

Mike Lloyd
Mike Lloyd

Sergio Rubio
Sergio Rubio

Farhad Farahi
Farhad Farahi

Lasantha Kularatne
Lasantha Kularatne

Mark Old
Mark Old

flw
flw

David Barda
David Barda

Geoff Lee
Geoff Lee

George Opritescu
George Opritescu

Grazfather
Grazfather

Michael Cordell
Michael Cordell

Patrick José Pereira
Patrick José Pereira

sherod taylor
sherod taylor

Andrew Scott
Andrew Scott

Lassi Piironen
Lassi Piironen

BlackWebWolf
BlackWebWolf

andrewzolotukhin
andrewzolotukhin

Leon Stigter
Leon Stigter

Amr Tamimi
Amr Tamimi

Jagdeep Singh
Jagdeep Singh

Lineu Felipe
Lineu Felipe

Konstantin
Konstantin

Brendan O'Leary
Brendan O’Leary

bertl4398
bertl4398

Ferenc-
Ferenc-

Rohan Verma
Rohan Verma

Tim Fitzgerald
Tim Fitzgerald

Federico Ruggi
Federico Ruggi

Craig Woodward
Craig Woodward

ReadmeCritic
ReadmeCritic

Eugene
Eugene

Kenny Wu
Kenny Wu

Renán Romero
Renán Romero

Bastian Groß
Bastian Groß

nicholas-eden
nicholas-eden

Dan Rabinowitz
Dan Rabinowitz

David Missmann
David Missmann

Mathias Weber
Mathias Weber

TheRedSpy15
TheRedSpy15

Harald Nordgren
Harald Nordgren

Matei Alexandru Gardus
Matei Alexandru Gardus

Sean Smith
Sean Smith

Halil Kaskavalci
Halil Kaskavalci

Johan Denoyer
Johan Denoyer

Jelle Vink
Jelle Vink

Devin Collins
Devin Collins

Danne Stayskal
Danne Stayskal

Max Beizer
Max Beizer


E:V:A

Gabriel
Gabriel

Andrew Scibek
Andrew Scibek

FriedCosey
FriedCosey

Michele Gerarduzzi
Michele Gerarduzzi

Jack Morris
Jack Morris

foorb
foorb

Levi Baber
Levi Baber

Graham Anderson
Graham Anderson

Romain Bossart
Romain Bossart

Kirill Motkov
Kirill Motkov

Brian Choromanski
Brian Choromanski

Sean DuBois
Sean DuBois

Gary Kim
Gary Kim

Dylan
Dylan

Dmytro Prokhorenkov
Dmytro Prokhorenkov

Elliot
Elliot

chenrui
chenrui

Andrew Suderman
Andrew Suderman

Bob 'Wombat' Hogg
Bob ‘Wombat’ Hogg

Christopher Hall
Christopher Hall

Heitor Neiva
Heitor Neiva

Herby Gillot
Herby Gillot

James Canning
James Canning

jeffz
jeffz

Mikkel Jeppesen Juhl
Mikkel Jeppesen Juhl

Erik
Erik

Nate Yourchuck
Nate Yourchuck

Casey Primozic
Casey Primozic

Alvaro [Andor]
Alvaro [Andor]

Joel Valentine
Joel Valentine

Viktor Braun
Viktor Braun

ChrisDBrown
ChrisDBrown

Narendra L
Narendra L

ibaum
ibaum

Tim Scheuermann
Tim Scheuermann

Indradhanush Gupta
Indradhanush Gupta

Victor Hugo Avelar Ossorio
Victor Hugo Avelar Ossorio

Steven Whitehead
Steven Whitehead

Lawrence Craft
Lawrence Craft

Avi Press
Avi Press

Sarah Kraßnigg
Sarah Kraßnigg

Jason Schweier
Jason Schweier

Massa
Massa

Vighnesh SK
Vighnesh SK

Alex Fornuto
Alex Fornuto

stevenwhitehead
stevenwhitehead

Johan Denoyer
Johan Denoyer

Albert Salim
Albert Salim

Ricardo N Feliciano
Ricardo N Feliciano

Omer Davutoglu
Omer Davutoglu

Hemu
Hemu

Dan Bent
Dan Bent

C123R
C123R

Matjaž Depolli
Matjaž Depolli

Toon Schoenmakers
Toon Schoenmakers

TDHTTTT
TDHTTTT

jottr
jottr

Nikolay Mateev
Nikolay Mateev

Charlie Wang
Charlie Wang

liyiheng
liyiheng

Acknowledgments

The inspiration for WTF came from Monica Dinculescu’s tiny-care-terminal.

WTF is built atop tcell and tview, fantastic projects both. WTF is built, packaged, and deployed via GoReleaser.