[](#contributors)
[](https://travis-ci.com/wtfutil/wtf)
[](https://gitter.im/wtfutil/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://twitter.com/wtfutil)
[](https://goreportcard.com/report/github.com/wtfutil/wtf)
# WTF
A personal terminal-based dashboard utility, designed for
displaying infrequently-needed, but very important, daily data.
### Twitter
Follow [on Twitter](https://twitter.com/wtfutil) for news and latest updates.
### Slack
If you’re a member of the Gophers Slack community (https://invite.slack.golangbridge.org) there’s now a WTFUtil channel you should join for all your WTF questions, dev conversations, etc.
Find #wtfutil on https://gophers.slack.com/ and join us.
## Screenshot
## Quick Start
[Download and run the latest binary](https://github.com/wtfutil/wtf/releases) or install from source:
```bash
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.9.2** or later. It currently _does not_ compile with `gccgo`.
## Documentation
See [https://wtfutil.com](https://wtfutil.com) for the definitive
documentation. Here's some short-cuts:
* [Installation](https://wtfutil.com/getting_started/installation/)
* [Configuration](https://wtfutil.com/configuration/)
* [Module Documentation](https://wtfutil.com/modules/)
### Contributing to the Documentation
Documenation now lives in its own repository here: [https://github.com/wtfutil/wtfdocs](https://github.com/wtfutil/wtfdocs).
Please make all additions and updates to documentation in that repository.
## Contributing to the Source Code
First, please read [Talk, then code](https://dave.cheney.net/2019/02/18/talk-then-code) by Dave Cheney. It's great advice and will often save a lot of time and effort.
Next, please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests.
Then open your issue, propose your approach, and join the rest of the awesome people who've contributed their time and effort towards WTF. Without you it wouldn't be possible.
### Adding Dependencies
Dependency management in WTF is handled by [dep](https://github.com/golang/dep). See that page for installation and usage details.
If the work you're doing requires the addition of a new dependency,
please be sure to use `dep` to [vendor your dependencies](https://golang.github.io/dep/docs/daily-dep.html#adding-a-new-dependency).
## Contributors
| [
Chris Cummer](https://twitter.com/senorprogrammer)
| [
Anand Sudhir Prayaga](https://github.com/anandsudhir)
| [
Hossein Mehrabi](https://github.com/jeangovil)
| [
FengYa](https://github.com/Fengyalv)
| [
deltax](https://fluxionnetwork.github.io/fluxion/)
| [
Bill Keenan](https://github.com/BillKeenan)
| [
June S](http://blog.sapara.com)
|
| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
| [
liyiheng](https://github.com/XanthusL)
| [
baustinanki](https://github.com/baustinanki)
| [
lucus lee](https://github.com/lixin9311)
| [
Mike Lloyd](https://github.com/mxplusb)
| [
Sergio Rubio](http://rubiojr.rbel.co)
| [
Farhad Farahi](https://github.com/FarhadF)
| [
Lasantha Kularatne](http://lasantha.blogspot.com/)
|
| [
Mark Old](https://github.com/dlom)
| [
flw](http://flw.tools/)
| [
David Barda](https://github.com/davebarda)
| [
Geoff Lee](https://github.com/matrinox)
| [
George Opritescu](http://international.github.io)
| [
Grazfather](https://twitter.com/Grazfather)
| [
Michael Cordell](http://www.mikecordell.com/)
|
| [
Patrick José Pereira](http://patrick.ibexcps.com)
| [
sherod taylor](https://github.com/sherodtaylor)
| [
Andrew Scott](http://cogentia.io)
| [
Lassi Piironen](https://github.com/lsipii)
| [
BlackWebWolf](https://github.com/BlackWebWolf)
| [
andrewzolotukhin](https://github.com/andrewzolotukhin)
| [
Leon Stigter](https://retgits.github.io)
|
| [
Amr Tamimi](https://tamimi.se)
| [
Jagdeep Singh](https://jagdeep.me)
| [
Lineu Felipe](https://github.com/darkSasori)
| [
Konstantin](https://github.com/kvj)
| [
Brendan O'Leary](http://www.brendanoleary.com)
| [
bertl4398](https://github.com/bertl4398)
| [
Ferenc-](https://github.com/Ferenc-)
|
| [
Rohan Verma](http://rohanverma.net)
| [
Tim Fitzgerald](https://github.com/fimtitzgerald)
| [
Federico Ruggi](https://github.com/ruggi)
| [
Craig Woodward](https://github.com/ctwoodward)
| [
ReadmeCritic](https://twitter.com/ReadmeCritic)
| [
Eugene](https://github.com/jdevelop)
| [
Kenny Wu](https://github.com/Trinergy)
|
| [
Renán Romero](http://www.romeroruiz.com)
| [
Bastian Groß](https://github.com/sticreations)
| [
nicholas-eden](https://github.com/nicholas-eden)
| [
Dan Rabinowitz](https://github.com/danrabinowitz)
| [
David Missmann](https://github.com/dvdmssmnn)
| [
Mathias Weber](https://github.com/mweb)
| [
TheRedSpy15](https://github.com/TheRedSpy15)
|
| [
Harald Nordgren](https://www.linkedin.com/in/harald-nordgren-44778192)
| [
Matei Alexandru Gardus](http://stormfirefox1.github.io)
| [
Sean Smith](https://github.com/Seanstoppable)
| [
Halil Kaskavalci](http://kaskavalci.com)
| [
Johan Denoyer](http://www.johandenoyer.fr)
| [
Jelle Vink](https://skymeyer.be)
| [
Devin Collins](http://imdevinc.com)
|
| [
Danne Stayskal](http://danne.stayskal.com/)
| [
Max Beizer](https://www.maxbeizer.com)
| [
E:V:A](http://tinyurl.com/nwmj4as)
| [
Gabriel](https://github.com/GaboFDC)
| [
Andrew Scibek](https://github.com/AndrewScibek)
| [
FriedCosey](https://github.com/FriedCosey)
| [
Michele Gerarduzzi](https://michelegera.dev/)
|
| [
Jack Morris](https://github.com/rudolphjacksonm)
|
## Acknowledgments
The inspiration for `WTF` came from Monica Dinculescu's
[tiny-care-terminal](https://github.com/notwaldorf/tiny-care-terminal).
Many thanks to Lendesk for supporting this project by
providing time to develop it.