WTF
A personal terminal-based dashboard utility, designed for displaying infrequently-needed, but very important, daily data.
Follow on Twitter 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 or install from source.
If you want to run the build command from within your $GOPATH
:
# Set the Go proxy variable to GoCenter
export GOPROXY="https://gocenter.io"
# 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 variable to GoCenter
export GOPROXY="https://gocenter.io"
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.11.0 or later (due to the use of Go modules). It currently does not compile with gccgo
.
Documentation
See https://wtfutil.com for the definitive documentation. Here's some short-cuts:
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.
Contributing to the Source Code
First, please read 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 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 Go modules. Please check out that page for more details on how Go modules work.
Contributors
Acknowledgments
The inspiration for WTF
came from Monica Dinculescu's
tiny-care-terminal.
Many thanks to Lendesk for supporting this project by providing time to develop it.