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](https://github.com/sponsors/senorprogrammer). #

* [Installation](#installation) * [Installing via Homebrew](#installing-via-homebrew) * [Installing via MacPorts](#installing-via-macports) * [Installing via Scarf](#installing-via-scarf) * [Installing a Binary](#installing-a-binary) * [Installing from Source](#installing-from-source) * [Running via Docker](#running-via-docker) * [Communication](#communication) * [Slack](#slack) * [Twitter](#twitter) * [Documentation](#documentation) * [Modules](#modules) * [Getting Bugs Fixed or Features Added](#getting-bugs-fixed-or-features-added) * [Contributing to the Source Code](#contributing-to-the-source-code) * [Adding Dependencies](#adding-dependencies) * [Contributing to the Documentation](#contributing-to-the-documentation) * [Contributors](#contributors) * [Acknowledgements](#acknowledgments)

## Installation ### Installing via Homebrew The simplest way from Homebrew: ```console 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: ```console brew tap wtfutil/wtfutil brew install wtfutil wtfutil ``` ### Installing via MacPorts You can also install via [MacPorts](https://www.macports.org/): ```console sudo port selfupdate sudo port install wtfutil wtfutil ``` ### Installing via Scarf You can also install via [Scarf](https://scarf.sh/package/senorprogrammer/wtfutil): ```console scarf install wtfutil wtfutil ``` ### Installing a Binary [Download the latest binary](https://github.com/wtfutil/wtf/releases) 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: ```bash 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`: ```bash # 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`: ```bash # 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: ```bash # 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](https://twitter.com/wtfutil) for news and latest updates. ## 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/) ## 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: * [GitHub](https://wtfutil.com/modules/github/) * [Google Calendar](https://wtfutil.com/modules/google/gcal/) * [HackerNews](https://wtfutil.com/modules/hackernews/) * [Have I Been Pwned](https://wtfutil.com/modules/hibp/) * [NewRelic](https://wtfutil.com/modules/newrelic/) * [OpsGenie](https://wtfutil.com/modules/opsgenie/) * [Security](https://wtfutil.com/modules/security/) * [Transmission](https://wtfutil.com/modules/transmission/) * [Trello](https://wtfutil.com/modules/trello/) ## 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](https://www.bountysource.com) to provide an incentive for someone to tackle it. ## Contributing to the Source Code First, kindly 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, kindly read [CONTRIBUTING.md](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](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](https://github.com/golang/go/wiki/Modules). Please check out that page for more details on how Go modules work. ## 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)
| [
_foorb](https://github.com/foorb)
| [
_{Levi Baber}](http://researchit.las.iastate.edu)
| [
_{Graham Anderson}](https://github.com/gnanderson)
| [
_{Romain Bossart}](https://github.com/bosr)
| [
_{Kirill Motkov}](http://eonix.ru)
| [
_{Brian Choromanski}](http://www.BrianChoromanski.com)
| | [
_{Sean DuBois}](http://siobud.com)
| [
_{Gary Kim}](https://github.com/gary-kim)
| [
_Dylan](https://dylanbartels.com)
| [
_{Dmytro Prokhorenkov}](http://liet.me)
| [
_Elliot](https://github.com/elliotrushton)
| [
_chenrui](http://chenrui.dev)
| [
_{Andrew Suderman}](https://github.com/sudermanjr)
| | [
_{Bob 'Wombat' Hogg}](https://github.com/rwhogg)
| [
_{Christopher Hall}](https://github.com/hxw)
| [
_{Heitor Neiva}](https://github.com/hneiva)
| [
_{Herby Gillot}](https://github.com/herbygillot)
| [
_{James Canning}](http://brudil.com)
| [
_jeffz](https://twitter.com/jeffz4000)
| [
_{Mikkel Jeppesen Juhl}](https://mikkeljuhl.com)
| | [
_Erik](https://github.com/lesteenman)
| [
_{Nate Yourchuck}](https://github.com/nyourchuck)
| [
_{Casey Primozic}](https://cprimozic.net/)
| [
_{Alvaro [Andor]}](http://pierdelacabeza.com/maruja)
| [
_{Joel Valentine}](https://github.com/Midnight-Conqueror)
| [
_{Viktor Braun}](https://www.viktor-braun.de)
| [
_ChrisDBrown](https://www.chrisdbrown.co.uk/)
| | [
_{Narendra L}](https://narengowda.github.io/)
| [
_ibaum](https://github.com/ibaum)
| [
_{Tim Scheuermann}](https://github.com/noxer)
| [
_{Indradhanush Gupta}](https://indradhanush.github.io/)
| [
_{Victor Hugo Avelar Ossorio}](https://victoravelar.com)
| [
_{Steven Whitehead}](https://github.com/scw007)
| [
_{Lawrence Craft}](https://github.com/lawrencecraft)
| | [
_{Avi Press}](http://avi.press)
| [
_{Sarah Kraßnigg}](https://github.com/Tardog)
| [
_{Jason Schweier}](http://jmks.ca)
| [
_Massa](https://github.com/massa1240)
| [
_{Vighnesh SK}](http://boot-error.github.io)
| [
_{Alex Fornuto}](http://alexfornuto.com)
| [
_{stevenwhitehead}](https://github.com/stevenwhitehead)
| | [
_{Johan Denoyer}](https://github.com/jdenoy-saagie)
| [
_{Albert Salim}](https://albertsalim.dev)
| [
_{Ricardo N Feliciano}](https://Feliciano.Tech)
| [
_{Omer Davutoglu}](https://github.com/3mard)
| [
_Hemu](https://github.com/hemu)
| [
_{Dan Bent}](https://github.com/Daanikus)
| [
_C123R](https://cizer.dev)
| | [
_{Matjaž Depolli}](https://github.com/madepolli)
| [
_{Toon Schoenmakers}](https://blog.schoentoon.blue)
| ## Acknowledgments The inspiration for `WTF` came from Monica Dinculescu's [tiny-care-terminal](https://github.com/notwaldorf/tiny-care-terminal). WTF is built atop [tcell](https://github.com/gdamore/tcell) and [tview](https://github.com/rivo/tview), fantastic projects both. WTF is built, packaged, and deployed via [GoReleaser](https://goreleaser.com).