diff --git a/.DS_Store b/.DS_Store deleted file mode 100644 index c815196b..00000000 Binary files a/.DS_Store and /dev/null differ diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 00000000..ca3324c1 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,21 @@ +root = true + +[*] +end_of_line = lf +insert_final_newline = true +max_line_length=120 + +[*.go] +indent_style = tab +indent_size = 4 +charset = utf-8 +trim_trailing_whitespace = true + +[*.html] +indent_style = tab +indent_size = 4 +charset = utf-8 +trim_trailing_whitespace = false + +[*.md] +trim_trailing_whitespace = false diff --git a/.github/ISSUE_TEMPLATE/Bug.md b/.github/ISSUE_TEMPLATE/Bug.md new file mode 100644 index 00000000..adda2996 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Bug.md @@ -0,0 +1,10 @@ +--- +name: Bug Report +about: Something is broken? +--- + +#### What's the problem? + + +#### How did you expect it to behave? + diff --git a/.github/ISSUE_TEMPLATE/Feature.md b/.github/ISSUE_TEMPLATE/Feature.md new file mode 100644 index 00000000..3d6ed228 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Feature.md @@ -0,0 +1,11 @@ +--- +name: Feature Request +about: You have a neat idea that should be implemented? +--- + +#### What problem does this solve? + + +#### How do envision it working? + + diff --git a/.github/ISSUE_TEMPLATE/Support.md b/.github/ISSUE_TEMPLATE/Support.md new file mode 100644 index 00000000..35d66b97 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Support.md @@ -0,0 +1,8 @@ +--- +name: ❓ Support Question +about: Have a problem that you can't figure out? +--- + +#### What problem are you having and how can we help? + + diff --git a/.github/PULL_REQUEST_TEMPLATE/Improvement.md b/.github/PULL_REQUEST_TEMPLATE/Improvement.md new file mode 100644 index 00000000..ef71c51d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/Improvement.md @@ -0,0 +1,11 @@ +--- +name: Improvement +about: You have some improvement to make wtf better? +--- + +#### What problem does this solve? + + +#### Is this related to an existing Issue? If so, which one? + + diff --git a/.github/PULL_REQUEST_TEMPLATE/Other.md b/.github/PULL_REQUEST_TEMPLATE/Other.md new file mode 100644 index 00000000..d6e0c64b --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/Other.md @@ -0,0 +1,11 @@ +--- +name: Other +about: You have some other ideas you want to introduce? +--- + + + +#### What problem does this solve? + + + diff --git a/.gitignore b/.gitignore index d5e25ce0..2d038a3c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,23 @@ +### Go ### +# Binaries for programs and plugins +*.exe +*.exe~ +*.dll +*.so +*.dylib + +# Test binary, build with `go test -c` +*.test + +# Output of the go coverage tool, specifically when used with LiteIDE +*.out + +# Misc .DS_Store gcal/client_secret.json +gspreadsheets/client_secret.json +#intellij idea +.idea/ + +dist/* +bin/ diff --git a/.goreleaser.yml b/.goreleaser.yml index fa4af340..e5ebdc42 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -9,3 +9,6 @@ builds: - linux goarch: - amd64 + +archive: + wrap_in_directory: true diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 00000000..b20b9c4a --- /dev/null +++ b/.travis.yml @@ -0,0 +1,12 @@ +language: go +go: + - "1.10" +sudo: false +before_install: + # Make sure travis builds work for forks + - mkdir -p $TRAVIS_BUILD_DIR $GOPATH/src/github.com/senorprogrammer + - test ! -d $GOPATH/src/github.com/senorprogrammer/wtf && mv $TRAVIS_BUILD_DIR $GOPATH/src/github.com/senorprogrammer/wtf || true + - export TRAVIS_BUILD_DIR=$HOME/gopath/src/github.com/senorprogrammer/wtf + - cd $HOME/gopath/src/github.com/senorprogrammer/wtf + +script: go get ./... && go get github.com/go-test/deep && go test -v github.com/senorprogrammer/wtf/wtf_tests diff --git a/Gopkg.lock b/Gopkg.lock new file mode 100644 index 00000000..d59fa66b --- /dev/null +++ b/Gopkg.lock @@ -0,0 +1,175 @@ +# This file is autogenerated, do not edit; changes may be undone by the next 'dep ensure'. + + +[[projects]] + name = "cloud.google.com/go" + packages = ["compute/metadata"] + revision = "0fd7230b2a7505833d5f69b75cbd6c9582401479" + version = "v0.23.0" + +[[projects]] + branch = "master" + name = "github.com/briandowns/openweathermap" + packages = ["."] + revision = "2adae1e5d10290d8cd435bd30296fc5e8f754862" + +[[projects]] + branch = "master" + name = "github.com/gdamore/encoding" + packages = ["."] + revision = "b23993cbb6353f0e6aa98d0ee318a34728f628b9" + +[[projects]] + name = "github.com/gdamore/tcell" + packages = [ + ".", + "terminfo" + ] + revision = "061d51a604c546b48e92253cb65190d76cecf4c6" + version = "v1.0.0" + +[[projects]] + name = "github.com/go-test/deep" + packages = ["."] + revision = "6592d9cc0a499ad2d5f574fde80a2b5c5cc3b4f5" + version = "v1.0.1" + +[[projects]] + name = "github.com/golang/protobuf" + packages = ["proto"] + revision = "b4deda0973fb4c70b50d226b1af49f3da59f5265" + version = "v1.1.0" + +[[projects]] + branch = "master" + name = "github.com/google/go-github" + packages = ["github"] + revision = "2ae5df7848328c214a48cec94c7d410cf8526527" + +[[projects]] + branch = "master" + name = "github.com/google/go-querystring" + packages = ["query"] + revision = "53e6ce116135b80d037921a7fdd5138cf32d7a8a" + +[[projects]] + name = "github.com/jessevdk/go-flags" + packages = ["."] + revision = "c6ca198ec95c841fdb89fc0de7496fed11ab854e" + version = "v1.4.0" + +[[projects]] + name = "github.com/lucasb-eyer/go-colorful" + packages = ["."] + revision = "345fbb3dbcdb252d9985ee899a84963c0fa24c82" + version = "v1.0" + +[[projects]] + name = "github.com/mattn/go-runewidth" + packages = ["."] + revision = "9e777a8366cce605130a531d2cd6363d07ad7317" + version = "v0.0.2" + +[[projects]] + branch = "master" + name = "github.com/olebedev/config" + packages = ["."] + revision = "9a10d05a33a8b9e828f20491e21e8927dec35f72" + +[[projects]] + name = "github.com/radovskyb/watcher" + packages = ["."] + revision = "6145e1439b9de93806925353403f91d2abbad8a5" + version = "v1.0.2" + +[[projects]] + branch = "master" + name = "github.com/rivo/tview" + packages = ["."] + revision = "71ecf1f4299c6d72b16d20da72405b7e85ac8720" + +[[projects]] + branch = "master" + name = "github.com/xanzy/go-gitlab" + packages = ["."] + revision = "73e9df58a3194b1256edae4d2e819603f06d428c" + +[[projects]] + branch = "master" + name = "github.com/yfronto/newrelic" + packages = ["."] + revision = "f7fa0c6f30ac3d86360c73726cfe9dd526a63d21" + +[[projects]] + branch = "master" + name = "golang.org/x/net" + packages = [ + "context", + "context/ctxhttp" + ] + revision = "1e491301e022f8f977054da4c2d852decd59571f" + +[[projects]] + branch = "master" + name = "golang.org/x/oauth2" + packages = [ + ".", + "google", + "internal", + "jws", + "jwt" + ] + revision = "1e0a3fa8ba9a5c9eb35c271780101fdaf1b205d7" + +[[projects]] + name = "golang.org/x/text" + packages = [ + "encoding", + "encoding/internal/identifier", + "internal/gen", + "transform", + "unicode/cldr" + ] + revision = "f21a4dfb5e38f5895301dc265a8def02365cc3d0" + version = "v0.3.0" + +[[projects]] + branch = "master" + name = "google.golang.org/api" + packages = [ + "calendar/v3", + "gensupport", + "googleapi", + "googleapi/internal/uritemplates" + ] + revision = "00e3bb8d04691e25ee2fccf98c866bcb7925c3ec" + +[[projects]] + name = "google.golang.org/appengine" + packages = [ + ".", + "internal", + "internal/app_identity", + "internal/base", + "internal/datastore", + "internal/log", + "internal/modules", + "internal/remote_api", + "internal/urlfetch", + "urlfetch" + ] + revision = "150dc57a1b433e64154302bdc40b6bb8aefa313a" + version = "v1.0.0" + +[[projects]] + name = "gopkg.in/yaml.v2" + packages = ["."] + revision = "5420a8b6744d3b0345ab293f6fcba19c978f1183" + version = "v2.2.1" + +[solve-meta] + analyzer-name = "dep" + analyzer-version = 1 + inputs-digest = "fd122eb7175ffd7db7cb197de13e0b850231ec9269a63a8ca9d117a8aa50d7e5" + solver-name = "gps-cdcl" + solver-version = 1 diff --git a/Gopkg.toml b/Gopkg.toml new file mode 100644 index 00000000..e64c4c7b --- /dev/null +++ b/Gopkg.toml @@ -0,0 +1,82 @@ +# Gopkg.toml example +# +# Refer to https://golang.github.io/dep/docs/Gopkg.toml.html +# for detailed Gopkg.toml documentation. +# +# required = ["github.com/user/thing/cmd/thing"] +# ignored = ["github.com/user/project/pkgX", "bitbucket.org/user/project/pkgA/pkgY"] +# +# [[constraint]] +# name = "github.com/user/project" +# version = "1.0.0" +# +# [[constraint]] +# name = "github.com/user/project2" +# branch = "dev" +# source = "github.com/myfork/project2" +# +# [[override]] +# name = "github.com/x/y" +# version = "2.4.0" +# +# [prune] +# non-go = false +# go-tests = true +# unused-packages = true + + +[[constraint]] + name = "github.com/briandowns/openweathermap" + branch = "master" + +[[constraint]] + name = "github.com/gdamore/tcell" + version = "1.0.0" + +[[constraint]] + name = "github.com/go-test/deep" + version = "1.0.1" + +[[constraint]] + name = "github.com/google/go-github" + branch = "master" + +[[constraint]] + name = "github.com/xanzy/go-gitlab" + branch = "master" + +[[constraint]] + name = "github.com/jessevdk/go-flags" + version = "1.4.0" + +[[constraint]] + branch = "master" + name = "github.com/olebedev/config" + +[[constraint]] + name = "github.com/radovskyb/watcher" + version = "1.0.2" + +[[constraint]] + branch = "master" + name = "github.com/rivo/tview" + +[[constraint]] + branch = "master" + name = "github.com/yfronto/newrelic" + +[[constraint]] + branch = "master" + name = "golang.org/x/oauth2" + +[[constraint]] + branch = "master" + name = "google.golang.org/api" + +[[constraint]] + name = "gopkg.in/yaml.v2" + version = "2.2.1" + +[prune] + go-tests = true + unused-packages = true diff --git a/LICENSE.md b/LICENSE.md index 7bbd1567..66214a8d 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,7 +1,109 @@ Copyright 2018, Chris Cummer -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: +Mozilla Public License, version 2.0 1. Definitions 1.1. “Contributor” means each individual or legal entity that creates, contributes to the creation of, or owns Covered Software. -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. +1.2. “Contributor Version” means the combination of the Contributions of others (if any) used by a Contributor and that particular Contributor’s Contribution. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +1.3. “Contribution” means Covered Software of a particular Contributor. + +1.4. “Covered Software” means Source Code Form to which the initial Contributor has attached the notice in Exhibit A, the Executable Form of such Source Code Form, and Modifications of such Source Code Form, in each case including portions thereof. + +1.5. “Incompatible With Secondary Licenses” means + +that the initial Contributor has attached the notice described in Exhibit B to the Covered Software; or + +that the Covered Software was made available under the terms of version 1.1 or earlier of the License, but not also under the terms of a Secondary License. + +1.6. “Executable Form” means any form of the work other than Source Code Form. + +1.7. “Larger Work” means a work that combines Covered Software with other material, in a separate file or files, that is not Covered Software. + +1.8. “License” means this document. + +1.9. “Licensable” means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or subsequently, any and all of the rights conveyed by this License. + +1.10. “Modifications” means any of the following: + +any file in Source Code Form that results from an addition to, deletion from, or modification of the contents of Covered Software; or + +any new file in Source Code Form that contains any Covered Software. + +1.11. “Patent Claims” of a Contributor means any patent claim(s), including without limitation, method, process, and apparatus claims, in any patent Licensable by such Contributor that would be infringed, but for the grant of the License, by the making, using, selling, offering for sale, having made, import, or transfer of either its Contributions or its Contributor Version. + +1.12. “Secondary License” means either the GNU General Public License, Version 2.0, the GNU Lesser General Public License, Version 2.1, the GNU Affero General Public License, Version 3.0, or any later versions of those licenses. + +1.13. “Source Code Form” means the form of the work preferred for making modifications. + +1.14. “You” (or “Your”) means an individual or a legal entity exercising rights under this License. For legal entities, “You” includes any entity that controls, is controlled by, or is under common control with You. For purposes of this definition, “control” means (a) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (b) ownership of more than fifty percent (50%) of the outstanding shares or beneficial ownership of such entity. + +2. License Grants and Conditions 2.1. Grants Each Contributor hereby grants You a world-wide, royalty-free, non-exclusive license: + +under intellectual property rights (other than patent or trademark) Licensable by such Contributor to use, reproduce, make available, modify, display, perform, distribute, and otherwise exploit its Contributions, either on an unmodified basis, with Modifications, or as part of a Larger Work; and + +under Patent Claims of such Contributor to make, use, sell, offer for sale, have made, import, and otherwise transfer either its Contributions or its Contributor Version. + +2.2. Effective Date The licenses granted in Section 2.1 with respect to any Contribution become effective for each Contribution on the date the Contributor first distributes such Contribution. + +2.3. Limitations on Grant Scope The licenses granted in this Section 2 are the only rights granted under this License. No additional rights or licenses will be implied from the distribution or licensing of Covered Software under this License. Notwithstanding Section 2.1(b) above, no patent license is granted by a Contributor: + +for any code that a Contributor has removed from Covered Software; or + +for infringements caused by: (i) Your and any other third party’s modifications of Covered Software, or (ii) the combination of its Contributions with other software (except as part of its Contributor Version); or + +under Patent Claims infringed by Covered Software in the absence of its Contributions. + +This License does not grant any rights in the trademarks, service marks, or logos of any Contributor (except as may be necessary to comply with the notice requirements in Section 3.4). + +2.4. Subsequent Licenses No Contributor makes additional grants as a result of Your choice to distribute the Covered Software under a subsequent version of this License (see Section 10.2) or under the terms of a Secondary License (if permitted under the terms of Section 3.3). + +2.5. Representation Each Contributor represents that the Contributor believes its Contributions are its original creation(s) or it has sufficient rights to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use This License is not intended to limit any rights You have under applicable copyright doctrines of fair use, fair dealing, or other equivalents. + +2.7. Conditions Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in Section 2.1. + +3. Responsibilities 3.1. Distribution of Source Form All distribution of Covered Software in Source Code Form, including any Modifications that You create or to which You contribute, must be under the terms of this License. You must inform recipients that the Source Code Form of the Covered Software is governed by the terms of this License, and how they can obtain a copy of this License. You may not attempt to alter or restrict the recipients’ rights in the Source Code Form. + +3.2. Distribution of Executable Form If You distribute Covered Software in Executable Form then: + +such Covered Software must also be made available in Source Code Form, as described in Section 3.1, and You must inform recipients of the Executable Form how they can obtain a copy of such Source Code Form by reasonable means in a timely manner, at a charge no more than the cost of distribution to the recipient; and + +You may distribute such Executable Form under the terms of this License, or sublicense it under different terms, provided that the license for the Executable Form does not attempt to limit or alter the recipients’ rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work You may create and distribute a Larger Work under terms of Your choice, provided that You also comply with the requirements of this License for the Covered Software. If the Larger Work is a combination of Covered Software with a work governed by one or more Secondary Licenses, and the Covered Software is not Incompatible With Secondary Licenses, this License permits You to additionally distribute such Covered Software under the terms of such Secondary License(s), so that the recipient of the Larger Work may, at their option, further distribute the Covered Software under the terms of either this License or such Secondary License(s). + +3.4. Notices You may not remove or alter the substance of any license notices (including copyright notices, patent notices, disclaimers of warranty, or limitations of liability) contained within the Source Code Form of the Covered Software, except that You may alter any license notices to the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations to one or more recipients of Covered Software. However, You may do so only on Your own behalf, and not on behalf of any Contributor. You must make it absolutely clear that any such warranty, support, indemnity, or liability obligation is offered by You alone, and You hereby agree to indemnify every Contributor for any liability incurred by such Contributor as a result of warranty, support, indemnity or liability terms You offer. You may include additional disclaimers of warranty and limitations of liability specific to any jurisdiction. + +4. Inability to Comply Due to Statute or Regulation If it is impossible for You to comply with any of the terms of this License with respect to some or all of the Covered Software due to statute, judicial order, or regulation then You must: (a) comply with the terms of this License to the maximum extent possible; and (b) describe the limitations and the code they affect. Such description must be placed in a text file included with all distributions of the Covered Software under this License. Except to the extent prohibited by statute or regulation, such description must be sufficiently detailed for a recipient of ordinary skill to be able to understand it. + +5. Termination 5.1. The rights granted under this License will terminate automatically if You fail to comply with any of its terms. However, if You become compliant, then the rights granted under this License from a particular Contributor are reinstated (a) provisionally, unless and until such Contributor explicitly and finally terminates Your grants, and (b) on an ongoing basis, if such Contributor fails to notify You of the non-compliance by some reasonable means prior to 60 days after You have come back into compliance. Moreover, Your grants from a particular Contributor are reinstated on an ongoing basis if such Contributor notifies You of the non-compliance by some reasonable means, this is the first time You have received notice of non-compliance with this License from such Contributor, and You become compliant prior to 30 days after Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent infringement claim (excluding declaratory judgment actions, counter-claims, and cross-claims) alleging that a Contributor Version directly or indirectly infringes any patent, then the rights granted to You by any and all Contributors for the Covered Software under Section 2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user license agreements (excluding distributors and resellers) which have been validly granted by You or Your distributors under this License prior to termination shall survive termination. + +6. Disclaimer of Warranty Covered Software is provided under this License on an “as is” basis, without warranty of any kind, either expressed, implied, or statutory, including, without limitation, warranties that the Covered Software is free of defects, merchantable, fit for a particular purpose or non-infringing. The entire risk as to the quality and performance of the Covered Software is with You. Should any Covered Software prove defective in any respect, You (not any Contributor) assume the cost of any necessary servicing, repair, or correction. This disclaimer of warranty constitutes an essential part of this License. No use of any Covered Software is authorized under this License except under this disclaimer. + +7. Limitation of Liability Under no circumstances and under no legal theory, whether tort (including negligence), contract, or otherwise, shall any Contributor, or anyone who distributes Covered Software as permitted above, be liable to You for any direct, indirect, special, incidental, or consequential damages of any character including, without limitation, damages for lost profits, loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses, even if such party shall have been informed of the possibility of such damages. This limitation of liability shall not apply to liability for death or personal injury resulting from such party’s negligence to the extent applicable law prohibits such limitation. Some jurisdictions do not allow the exclusion or limitation of incidental or consequential damages, so this exclusion and limitation may not apply to You. + +8. Litigation Any litigation relating to this License may be brought only in the courts of a jurisdiction where the defendant maintains its principal place of business and such litigation shall be governed by laws of that jurisdiction, without reference to its conflict-of-law provisions. Nothing in this Section shall prevent a party’s ability to bring cross-claims or counter-claims. + +9. Miscellaneous This License represents the complete agreement concerning the subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. Any law or regulation which provides that the language of a contract shall be construed against the drafter shall not be used to construe this License against a Contributor. + +10. Versions of the License 10.1. New Versions Mozilla Foundation is the license steward. Except as provided in Section 10.3, no one other than the license steward has the right to modify or publish new versions of this License. Each version will be given a distinguishing version number. + +10.2. Effect of New Versions You may distribute the Covered Software under the terms of the version of the License under which You originally received the Covered Software, or under the terms of any subsequent version published by the license steward. + +10.3. Modified Versions If you create software not governed by this License, and you want to create a new license for such software, you may create and use a modified version of this License if you rename the license and remove any references to the name of the license steward (except to note that such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses If You choose to distribute Source Code Form that is Incompatible With Secondary Licenses under the terms of this version of the License, the notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - “Incompatible With Secondary Licenses” Notice This Source Code Form is “Incompatible With Secondary Licenses”, as defined by the Mozilla Public License, v. 2.0. diff --git a/Makefile b/Makefile index 0828bf38..4d54bd05 100644 --- a/Makefile +++ b/Makefile @@ -2,13 +2,13 @@ BRANCH := `git rev-parse --abbrev-ref HEAD` .PHONY: dependencies install run -dependencies: - go get -v ./... +build: + go build -o bin/wtf install: which wtf | xargs rm || true go install -ldflags="-X main.version=$(shell git describe --always --abbrev=6)_$(BRANCH) -X main.date=$(shell date +%FT%T%z)" which wtf -run: - wtf +run: build + bin/wtf diff --git a/README.md b/README.md index 5148713e..d9a53bd7 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ +

+ +

+

- +

A personal terminal-based dashboard utility, designed for @@ -13,16 +17,24 @@ displaying infrequently-needed, but very important, daily data. ### Installation from Source -*Note:* This has only been tested to build against Go 1.9.2. It won't -work with Go versions < 1.7, and only _may_ work on other versions. +**Note:** WTF is _only_ compatible with Go versions **1.9.2** or later. It currently _does not_ compile with `gccgo`. ```bash -go get github.com/senorprogrammer/wtf +go get -u github.com/senorprogrammer/wtf cd $GOPATH/src/github.com/senorprogrammer/wtf make install make run ``` +Or [download the latest binary](https://github.com/senorprogrammer/wtf/releases). + +## Support + +Chat on Gitter +[![Join the chat at https://gitter.im/wtfutil/Lobby](https://badges.gitter.im/wtfutil/Lobby.svg)](https://gitter.im/wtfutil/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) + +## Documentation + See [https://wtfutil.com](https://wtfutil.com) for the definitive documentation. Here's some short-cuts: @@ -30,23 +42,6 @@ documentation. Here's some short-cuts: * [Configuration](http://wtfutil.com/posts/configuration/) * [Module Documentation](http://wtfutil.com/posts/modules/) -And a "probably up-to-date" list of currently-implemented modules: - -* [BambooHR](http://wtfutil.com/posts/modules/bamboohr/) -* [World Clocks](http://wtfutil.com/posts/modules/clocks/) -* [Command Runner](http://wtfutil.com/posts/modules/cmdrunner/) -* [Google Calendar](http://wtfutil.com/posts/modules/gcal/) -* [Git](http://wtfutil.com/posts/modules/git/) -* [GitHub](http://wtfutil.com/posts/modules/github/) -* [Jira](http://wtfutil.com/posts/modules/jira/) -* [New Relic](http://wtfutil.com/posts/modules/newrelic/) -* [OpsGenie](http://wtfutil.com/posts/modules/opsgenie) -* [Power](http://wtfutil.com/posts/modules/power/) -* [Security](http://wtfutil.com/posts/modules/security/) -* [Textfile](http://wtfutil.com/posts/modules/textfile/) -* [Todo List](http://wtfutil.com/posts/modules/todo/) -* [Weather](http://wtfutil.com/posts/modules/weather/) - ## Contributing Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests. @@ -78,3 +73,8 @@ Many thanks to all these developers. * [openweathermap](https://github.com/briandowns/openweathermap) * [tcell](https://github.com/gdamore/tcell) * [tview](https://github.com/rivo/tview) + +

+ +

+ diff --git a/_sample_configs/bargraph_config.yml b/_sample_configs/bargraph_config.yml new file mode 100644 index 00000000..577771ee --- /dev/null +++ b/_sample_configs/bargraph_config.yml @@ -0,0 +1,27 @@ +wtf: + colors: + border: + focusable: darkslateblue + focused: orange + normal: gray + grid: + columns: [40, 40] + rows: [13, 13, 4] + refreshInterval: 1 + mods: + bargraph: + colors: + from: + name: coral + displayName: grey + to: + name: white + price: green + enabled: true + position: + top: 2 + left: 0 + height: 2 + width: 2 + refreshInterval: 30 + updateInterval: 15 \ No newline at end of file diff --git a/_sample_configs/complex_config.yml b/_sample_configs/complex_config.yml index c21bdb72..57e3f41c 100644 --- a/_sample_configs/complex_config.yml +++ b/_sample_configs/complex_config.yml @@ -79,6 +79,25 @@ wtf: refreshInterval: 300 secretFile: "~/.wtf/gcal/client_secret.json" withLocation: true + gspreadsheets: + enabled: true + secretFile: "~/.wtf/gspreadsheets/client_secret.json" + refreshInterval: "300" + sheetId: "id_of_google_spreadsheet" + colors: + values: "green" + cells: + names: + - "Cell 1 name" + - "Cell 2 name" + addresses: + - "A1" + - "A2" + position: + top: 0 + left: 0 + width: 1 + height: 1 git: commitCount: 5 enabled: true @@ -199,3 +218,17 @@ wtf: width: 1 refreshInterval: 90 tempUnit: "C" + blockfolio: + enabled: true + displayHoldings: true + refreshInterval: 400 + device_token: "device token here, you can find how to get it here https://github.com/bob6664569/blockfolio-api-client" + colors: + name: blue + grows: green + drop: red + position: + top: 3 + left: 1 + width: 1 + height: 1 \ No newline at end of file diff --git a/_site/content/posts/configuration.md b/_site/content/posts/configuration.md index 183f0119..af97ed86 100644 --- a/_site/content/posts/configuration.md +++ b/_site/content/posts/configuration.md @@ -4,6 +4,12 @@ date: 2018-04-15T21:17:16-07:00 draft: false --- +## Index + +* [Configuration Files](#configuration-files) +* [Environment (ENV) Variables](#environment-env-variables) +* [Grid Layout](#grid-layout) + ## Configuration Files By default WTF looks in a `~/.wtf/` directory for a YAML file called @@ -51,3 +57,30 @@ wouldn't want to have laying about in the config files. For modules that require them, the name of the required environment variable(s) can be found in that module's "Required ENV Variables" section of the documentation. See OpsGenie for an example. + +## Grid Layout + +WTF uses the `Grid` layout system from [tview](https://github.com/rivo/tview/blob/master/grid.go) to position widgets +onscreen. It's not immediately obvious how this works, so here's an +explanation: + +Think of your terminal screen as a matrix of letter positions, say `100` chrs wide and `58` chrs tall. + +Columns breaks up the width of the screen into chunks, each chunk a specified number of characters wide. use + +`[10, 10, 10, 10, 10, 10, 10, 10, 10, 10]` + +Ten columns that are ten characters wide + +Rows break up the height of the screen into chunks, each chunk a specified number of characters tall. If we wanted to have five rows: + +`[10, 10, 10, 10, 18]` + +The co-ordinate system starts at top-left and defines how wide and tall a widget is. If we wanted to put a 2-col, 2-row widget in the bottom of the screen, we'd position it at: + +``` + top: 4 // top starts in the 4th row + left: 9 // left starts in the 9th column + height: 2 // span down rows 4 & 5 (18 characters in size, total) + width: 2 // span across cols 9 & 10 (20 characters in size, total) +``` diff --git a/_site/content/posts/configuration/attributes.md b/_site/content/posts/configuration/attributes.md index 93e7c3bb..2850875e 100644 --- a/_site/content/posts/configuration/attributes.md +++ b/_site/content/posts/configuration/attributes.md @@ -72,7 +72,8 @@ change.
Values: A positive integer, `0..n`. `term`
-This value is _optional_. Sets a custom value for the terminal type this app runs in. Leave this entry out of the config if you simply want to use your terminal's +_Optional_.
+Sets a custom value for the terminal type this app runs in. Leave this entry out of the config if you simply want to use your terminal's default setting.
**Note:** If an invalid value is provided for this setting, the app will crash with a `"terminal entry not found"` error.
diff --git a/_site/content/posts/installation.md b/_site/content/posts/installation.md index 24829498..dcc4aafa 100644 --- a/_site/content/posts/installation.md +++ b/_site/content/posts/installation.md @@ -11,7 +11,7 @@ There are two ways to install WTF: Get this repo and install the dependencies: ```bash -go get github.com/senorprogrammer/wtf +go get -u github.com/senorprogrammer/wtf cd $GOPATH/src/github.com/senorprogrammer/wtf make install make run diff --git a/_site/content/posts/modules/bamboohr.md b/_site/content/posts/modules/bamboohr.md index 6186e6f9..2ca3e35f 100644 --- a/_site/content/posts/modules/bamboohr.md +++ b/_site/content/posts/modules/bamboohr.md @@ -1,5 +1,5 @@ --- -title: "Modules: Bamboohr" +title: "BambooHR" date: 2018-05-07T20:17:37-07:00 draft: false --- diff --git a/_site/content/posts/modules/circleci.md b/_site/content/posts/modules/circleci.md new file mode 100644 index 00000000..4a2df2d9 --- /dev/null +++ b/_site/content/posts/modules/circleci.md @@ -0,0 +1,53 @@ +--- +title: "CircleCI" +date: 2018-06-10T19:26:08-04:00 +draft: false +--- + +Added in `v0.0.7`. + +Displays build information for your CircleCI account. + +circleci screenshot + +## Source Code + +```bash +wtf/circleci/ +``` + +## Required ENV Variables + +Key: `WTF_CIRCLE_API_KEY`
+Value: Your CircleCI API +token. + +## Keyboard Commands + +None. + +## Configuration + +```yaml +circleci: + enabled: true + position: + top: 4 + left: 1 + height: 1 + width: 2 + refreshInterval: 900 +``` + +### Attributes + +`enabled`
+Determines whether or not this module is executed and if its data displayed onscreen.
+Values: `true`, `false`. + +`position`
+Defines where in the grid this module's widget will be displayed.
+ +`refreshInterval`
+How often, in seconds, this module will update its data.
+Values: A positive integer, `0..n`. diff --git a/_site/content/posts/modules/clocks.md b/_site/content/posts/modules/clocks.md index 512a13ce..3d99e249 100644 --- a/_site/content/posts/modules/clocks.md +++ b/_site/content/posts/modules/clocks.md @@ -1,5 +1,5 @@ --- -title: "Modules: Clocks" +title: "Clocks" date: 2018-05-07T19:47:31-07:00 draft: false --- diff --git a/_site/content/posts/modules/cmdrunner.md b/_site/content/posts/modules/cmdrunner.md index 8975d2c3..856984bf 100644 --- a/_site/content/posts/modules/cmdrunner.md +++ b/_site/content/posts/modules/cmdrunner.md @@ -1,5 +1,5 @@ --- -title: "Modules: CmdRunner" +title: "CmdRunner" date: 2018-05-17T17:17:10-07:00 draft: false --- @@ -38,7 +38,7 @@ cmdrunner: ### Attributes `args`
-The arguments to the command, with each item as an element in an array. +The arguments to the command, with each item as an element in an array. Example: for `curl -I cisco.com`, the arguments array would be `["-I", "cisco.com"]`. `cmd`
diff --git a/_site/content/posts/modules/cryptocurrencies/bittrex.md b/_site/content/posts/modules/cryptocurrencies/bittrex.md new file mode 100644 index 00000000..8ee4ad37 --- /dev/null +++ b/_site/content/posts/modules/cryptocurrencies/bittrex.md @@ -0,0 +1,87 @@ +--- +title: "Bittrex" +date: 2018-06-04T20:06:40-07:00 +draft: false +--- + +Added in `v0.0.5`. + +Get the last 24 hour summary of cryptocurrencies market using [Bittrex](https://bittrex.com). + +bittrex screenshot + +## Source Code + +```bash +wtf/cryptoexchanges/bittrex/ +``` + +## Required ENV Variables + +None. + +## Keyboard Commands + +None. + +## Configuration + +```yaml +bittrex: + enabled: true + position: + top: 1 + left: 2 + height: 3 + width: 1 + refreshInterval: 5 + summary: + BTC: + displayName: Bitcoin + market: + - LTC + - ETH + colors: + base: + name: orange + displayName: red + market: + name: red + field: white + value: green +``` + +### Attributes + +`colors.base.name`
+Values: Any X11 +color name. + +`colors.base.dispayName`
+Values: Any X11 +color name. + +`colors.market.name`
+Values: Any X11 +color name. + +`colors.market.field`
+Values: Any X11 +color name. + +`colors.market.value`
+Values: Any X11 +color name. + +`summary`
+ +`enabled`
+Determines whether or not this module is executed and if its data displayed onscreen.
+Values: `true`, `false`. + +`position`
+Defines where in the grid this module's widget will be displayed.
+ +`refreshInterval`
+How often, in seconds, this module will update its data.
+Values: A positive integer, `0..n`. diff --git a/_site/content/posts/modules/cryptocurrencies/blockfolio.md b/_site/content/posts/modules/cryptocurrencies/blockfolio.md new file mode 100644 index 00000000..06df64cc --- /dev/null +++ b/_site/content/posts/modules/cryptocurrencies/blockfolio.md @@ -0,0 +1,75 @@ +--- +title: "Blockfolio" +date: 2018-06-13T09:29:59-07:00 +draft: false +--- + +Added in `v0.0.8`. + +Display your Blockfolio crypto holdings. + +blockfolio screenshot + +## Source + +```bash +wtf/blockfolio/ +``` + +## Required ENV Variables + +None. + +## Keyboard Commands + +None. + +## Configuration + +```yaml +blockfolio: + colors: + name: blue + grows: green + drop: red + device_token: "device token" + displayHoldings: true + enabled: true + position: + top: 3 + left: 1 + width: 1 + height: 1 + refreshInterval: 400 +``` + +### Attributes + +`colors.name`
+Values: Any X11 +color name. + +`colors.grows`
+Values: Any X11 +color name. + +`colors.drop`
+Values: Any X11 +color name. + +`device_token`
+Value: See [this gist](https://github.com/bob6664569/blockfolio-api-client) for +details on how to get your Blockfolio API token. + +`displayHoldings`
+ +`enabled`
+Determines whether or not this module is executed and if its data displayed onscreen.
+Values: `true`, `false`. + +`position`
+Defines where in the grid this module's widget will be displayed.
+ +`refreshInterval`
+How often, in seconds, this module will update its data.
+Values: A positive integer, `0..n`. diff --git a/_site/content/posts/modules/cryptocurrencies/cryptolive.md b/_site/content/posts/modules/cryptocurrencies/cryptolive.md new file mode 100644 index 00000000..bf38443b --- /dev/null +++ b/_site/content/posts/modules/cryptocurrencies/cryptolive.md @@ -0,0 +1,89 @@ +--- +title: "CryptoLive" +date: 2018-06-03T20:06:40-07:00 +draft: false +--- + +Added in `v0.0.5`. + +Compare crypto currencies using [CryptoCompare](https://cryptocompare.com). + +cryptolive screenshot + +## Source Code + +```bash +wtf/cryptoexchanges/cryptolive/ +``` + +## Required ENV Vars + +None. + +## Keyboard Commands + +None. + +## Configuration + +```yaml +cryptolive: + colors: + from: + name: coral + displayName: grey + to: + name: white + price: green + currencies: + BTC: + displayName: Bitcoin + to: + - USD + - EUR + - ETH + ETH: + displayName: Ethereum + to: + - USD + - EUR + - ETH + enabled: true + position: + top: 5 + left: 2 + height: 1 + width: 2 + updateInterval: 15 +``` + +### Attributes + +`colors.from.name`
+Values: Any X11 +color name. + +`colors.from.dispayName`
+Values: Any X11 +color name. + +`colors.to.name`
+Values: Any X11 +color name. + +`colors.to.price`
+Values: Any X11 +color name. + +`currencies`
+ +`enabled`
+Determines whether or not this module is executed and if its data displayed onscreen.
+Values: `true`, `false`. + +`position`
+Defines where in the grid this module's widget will be displayed.
+ +`refreshInterval`
+How often, in seconds, this module will update its data.
+Values: A positive integer, `0..n`. diff --git a/_site/content/posts/modules/gcal.md b/_site/content/posts/modules/gcal.md index 29860761..03593431 100644 --- a/_site/content/posts/modules/gcal.md +++ b/_site/content/posts/modules/gcal.md @@ -1,5 +1,5 @@ --- -title: "Modules: Google Calendar" +title: "Google Calendar" date: 2018-05-10T08:25:33-07:00 draft: false --- @@ -8,6 +8,9 @@ Displays your upcoming Google calendar events. gcal screenshot +**Not:** Setting up access to Google Calendars for Go is a bit unobvious. Check out Google's [Go Quickstart](https://developers.google.com/calendar/quickstart/go) +first and if you have problems, then take a look at this [comment by WesleydeSouza](https://github.com/senorprogrammer/wtf/issues/83#issuecomment-393665229) which offers a slightly different approach. + ## Source Code ```bash @@ -16,11 +19,7 @@ wtf/gcal/ ## Required ENV Variables -Key: `WTF_GOOGLE_CAL_CLIENT_ID`
-Value: Your Google API client ID. - -Key: `WTF_GOOGLE_CAL_CLIENT_SECRET`
-Value: Your Google API client secret. +None. ## Keyboard Commands diff --git a/_site/content/posts/modules/git.md b/_site/content/posts/modules/git.md index ba0958ea..e0a6a1f2 100644 --- a/_site/content/posts/modules/git.md +++ b/_site/content/posts/modules/git.md @@ -1,5 +1,5 @@ --- -title: "Modules: Git" +title: "Git" date: 2018-05-09T14:20:48-07:00 draft: false --- diff --git a/_site/content/posts/modules/github.md b/_site/content/posts/modules/github.md index f1339488..f81a6707 100644 --- a/_site/content/posts/modules/github.md +++ b/_site/content/posts/modules/github.md @@ -1,13 +1,11 @@ --- -title: "Modules: Github" +title: "GitHub" date: 2018-05-09T19:20:20-07:00 draft: false --- -Displays information about git repositories hosted on Github: open -review requests, and open pull requests. +Displays information about your git repositories hosted on Github: -github screenshot #### Open Review Requests @@ -17,6 +15,8 @@ All open code review requests assigned to you. All open pull requests created by you. +github screenshot + ## Source Code ```bash diff --git a/_site/content/posts/modules/gitlab.md b/_site/content/posts/modules/gitlab.md new file mode 100644 index 00000000..df9f744f --- /dev/null +++ b/_site/content/posts/modules/gitlab.md @@ -0,0 +1,90 @@ +--- +title: "Gitlab" +date: 2018-06-08T13:14:11-07:00 +draft: false +--- + +Added in `v0.0.8`. + +gitlab screenshot + +Displays information about your projects hosted on Gitlab: + +#### Open Approval Requests + +All open merge requests that are requesting your approval. + +#### Open Merge Requests + +All open merge requests created by you. + +## Source Code + +```bash +wtf/gitlab/ +``` + +## Required ENV Variables + +Key: `WTF_GITLAB_TOKEN`
+Action: A Gitlab personal access token. Requires at least `api` access. + +## Keyboard Commands + +Key: `/`
+Action: Open/close the widget's help window. + +Key: `h`
+Action: Show the previous project. + +Key: `l`
+Action: Show the next project. + +Key: `←`
+Action: Show the previous project. + +Key: `→`
+Action: Show the next project. + +## Configuration + +```yaml +gitlab: + enabled: true + position: + top: 2 + left: 3 + height: 2 + width: 2 + refreshInterval: 300 + projects: + tasks: "gitlab-org/release" + gitlab-ce: "gitlab-org" + username: "senorprogrammer" +``` + +### Attributes + +`enabled`
+Determines whether or not this module is executed and if its data displayed onscreen.
+Values: `true`, `false`. + +`position`
+Defines where in the grid this module's widget will be displayed.
+ +`refreshInterval`
+How often, in seconds, this module will update its data.
+Values: A positive integer, `0..n`. + +`domain`
+_Optional_. Your Gitlab corporate domain.
+Values: A valid URI. + +`projects`
+A list of key/value pairs each describing a Gitlab project to fetch data +for.
+Key: The name of the project.
+Value: The namespace of the project. + +`username`
+Your Gitlab username. Used to figure out which requests require your approval diff --git a/_site/content/posts/modules/gspreadsheet.md b/_site/content/posts/modules/gspreadsheet.md new file mode 100644 index 00000000..0d3e5a94 --- /dev/null +++ b/_site/content/posts/modules/gspreadsheet.md @@ -0,0 +1,70 @@ +--- +title: "Google Spreadsheets" +date: 2018-06-10T18:26:26-04:00 +draft: false +--- + +Added in `v0.0.7`. + +Display information from cells in a Google Spreadsheet. + +```bash +wtf/gspreadsheets/ +``` + +## Required ENV Variables + +None. + +## Keyboard Commands + +None. + +## Configuration + +```yaml +gspreadsheets: + colors: + values: "green" + cells: + names: + - "Cell 1 name" + - "Cell 2 name" + addresses: + - "A1" + - "A2" + enabled: true + position: + top: 0 + left: 0 + width: 1 + height: 1 + refreshInterval: "300" + secretFile: "~/.wtf/gspreadsheets/client_secret.json" + sheetId: "id_of_google_spreadsheet" +``` + +### Attributes + +`colors.values`
+The color to display the cell values in.
+Values: Any X11 color name. + +`cells.names`
+ +`cells.addresses`
+ +`enabled`
+Whether or not this module is executed and if its data displayed onscreen.
+Values: `true`, `false`. + +`position`
+Where in the grid this module's widget will be displayed.
+ +`refreshInterval`
+How often, in seconds, this module will update its data.
+Values: A positive integer, `0..n`. + +`secretFile`
+Your Google client secret JSON file.
+Values: A string representing a file path to the JSON secret file. diff --git a/_site/content/posts/modules/ipapi.md b/_site/content/posts/modules/ipapi.md new file mode 100644 index 00000000..986aa172 --- /dev/null +++ b/_site/content/posts/modules/ipapi.md @@ -0,0 +1,62 @@ +--- +title: "IP-API" +date: 2018-06-10T19:41:52-04:00 +draft: false +--- + +Added in `v0.0.7`. + +Displays your current IP address information, from [IP-APIcom](http://ip-api.com). + +**Note:** IP-API.com has a free-plan rate limit of 120 requests per +minute. + +## Source Code + +```bash +wtf/ipapi/ +``` + +## Required ENV Variables + +None. + +## Keyboard Commands + +None. + +## Configuration + +```yaml +ipinfo: + colors: + name: red + value: white + enabled: true + position: + top: 1 + left: 2 + height: 1 + width: 1 + refreshInterval: 150 +``` +### Attributes + +`colors.name`
+The default colour for the row names.
+Values: Any X11 color name. + +`colors.value`
+The default colour for the row values.
+Values: Any X11 color name. + +`enabled`
+Determines whether or not this module is executed and if its data displayed onscreen.
+Values: `true`, `false`. + +`position`
+Defines where in the grid this module's widget will be displayed.
+ +`refreshInterval`
+How often, in seconds, this module will update its data.
+Values: A positive integer, `0..n`. diff --git a/_site/content/posts/modules/ipinfo.md b/_site/content/posts/modules/ipinfo.md new file mode 100644 index 00000000..93b8edb2 --- /dev/null +++ b/_site/content/posts/modules/ipinfo.md @@ -0,0 +1,62 @@ +--- +title: "IPInfo" +date: 2018-06-01T23:18:48-07:00 +draft: false +--- + +Displays your current IP address information, from ipinfo.io. + +**Note:** IPInfo.io has a free-plan rate limit of 1000 requests per day. + +ipinfo screenshot + +## Source Code + +```bash +wtf/ipinfo/ +``` + +## Required ENV Variables + +None. + +## Keyboard Commands + +None. + +## Configuration + +```yaml +ipinfo: + colors: + name: red + value: white + enabled: true + position: + top: 1 + left: 2 + height: 1 + width: 1 + refreshInterval: 150 +``` + +### Attributes + +`colors.name`
+The default colour for the row names.
+Values: Any X11 color name. + +`colors.value`
+The default colour for the row values.
+Values: Any X11 color name. + +`enabled`
+Determines whether or not this module is executed and if its data displayed onscreen.
+Values: `true`, `false`. + +`position`
+Defines where in the grid this module's widget will be displayed.
+ +`refreshInterval`
+How often, in seconds, this module will update its data.
+Values: A positive integer, `0..n`. diff --git a/_site/content/posts/modules/jenkins.md b/_site/content/posts/modules/jenkins.md new file mode 100644 index 00000000..c556998e --- /dev/null +++ b/_site/content/posts/modules/jenkins.md @@ -0,0 +1,63 @@ +--- +title: "Modules: Jenkins" +date: 2018-06-09T20:53:35-07:00 +draft: false +--- + +Added in `v0.0.8`. + +Displays jenkins status of given builds in a project or view + +jenkins screenshot + +## Source Code + +```bash +wtf/jenkins/ +``` + +## Required ENV Variables + +Key: `WTF_JENKINS_API_KEY`
+Value: Your Jenkins API key. + +## Keyboard Commands + +None. + +## Configuration + +```yaml +jenkins: + enabled: true + position: + top: 2 + left: 3 + height: 2 + width: 3 + refreshInterval: 300 + url: "https://jenkins.domain.com/jenkins/view_url" + user: "username" +``` + +### Attributes + +`enabled`
+Determines whether or not this module is executed and if its data displayed onscreen.
+Values: `true`, `false`. + +`position`
+Defines where in the grid this module's widget will be displayed. + +`refreshInterval`
+How often, in seconds, this module will update its data.
+Values: A positive integer, `0..n`. + +`user`
+Your Jenkins username.
+ +`url`
+The url to your Jenkins project or view.
+Values: A valid URI. + diff --git a/_site/content/posts/modules/jira.md b/_site/content/posts/modules/jira.md index 008db39a..a25cc1f3 100644 --- a/_site/content/posts/modules/jira.md +++ b/_site/content/posts/modules/jira.md @@ -1,5 +1,5 @@ --- -title: "Modules: Jira" +title: "Jira" date: 2018-05-10T10:44:35-07:00 draft: false --- @@ -25,6 +25,8 @@ None. ## Configuration +### Single Jira Project + ```yaml jira: colors: @@ -34,12 +36,38 @@ jira: domain: "https://umbrellacorp.atlassian.net" email: "chriscummer@me.com" enabled: true + jql: "issueType = Story" position: top: 4 left: 1 height: 1 width: 2 - project: "JIRA" + project: "ProjectA" + refreshInterval: 900 + username: "chris.cummer" +``` + +### Multiple Jira Projects + +If you want to monitor multiple Jira projects, use the following +configuration (note the difference in `project`): + +```yaml +jira: + colors: + rows: + even: "lightblue" + odd: "white" + domain: "https://umbrellacorp.atlassian.net" + email: "chriscummer@me.com" + enabled: true + jql: "issueType = Story" + position: + top: 4 + left: 1 + height: 1 + width: 2 + project: ["ProjectA", "ProjectB"] refreshInterval: 900 username: "chris.cummer" ``` @@ -68,6 +96,11 @@ Values: A valid email address string. Determines whether or not this module is executed and if its data displayed onscreen.
Values: `true`, `false`. +`jql`
+_Optional_
+Custom JQL to be appended to the search query.
+Values: See Search Jira like a boss with JQL for details. + `position`
Defines where in the grid this module's widget will be displayed.
diff --git a/_site/content/posts/modules/newrelic.md b/_site/content/posts/modules/newrelic.md index b8ca07d5..e7eb1fbc 100644 --- a/_site/content/posts/modules/newrelic.md +++ b/_site/content/posts/modules/newrelic.md @@ -1,5 +1,5 @@ --- -title: "Modules: New Relic" +title: "New Relic" date: 2018-05-09T09:01:14-07:00 draft: false --- diff --git a/_site/content/posts/modules/opsgenie.md b/_site/content/posts/modules/opsgenie.md index ab2cc912..5d34d4be 100644 --- a/_site/content/posts/modules/opsgenie.md +++ b/_site/content/posts/modules/opsgenie.md @@ -1,5 +1,5 @@ --- -title: "Modules: OpsGenie" +title: "OpsGenie" date: 2018-05-08T20:53:40-07:00 draft: false --- diff --git a/_site/content/posts/modules/power.md b/_site/content/posts/modules/power.md index b3bd4fdb..7ecc728d 100644 --- a/_site/content/posts/modules/power.md +++ b/_site/content/posts/modules/power.md @@ -1,5 +1,5 @@ --- -title: "Modules: Power" +title: "Power" date: 2018-05-26T19:26:23-07:00 draft: false --- diff --git a/_site/content/posts/modules/prettyweather.md b/_site/content/posts/modules/prettyweather.md new file mode 100644 index 00000000..66a78c1e --- /dev/null +++ b/_site/content/posts/modules/prettyweather.md @@ -0,0 +1,67 @@ +--- +title: "Pretty Weather" +date: 2018-06-02T05:32:04-07:00 +draft: false +--- + +Displays weather information as ASCII art from +[Wttr.in](http://wttr.in). + +prettyweather screenshot + +## Source Code + +```bash +wtf/prettyweather/ +``` + +## Required ENV Variables + +None. + +## Keyboard Commands + +None. + +## Configuration + +```yaml + prettyweather: + enabled: true + city: "tehran" + position: + top: 3 + left: 5 + height: 1 + width: 1 + refreshInterval: 300 + unit: "c" + view: 0 +``` + +### Attributes + +`city`
+_Optional_. It will grab the current location from your IP address if +omitted.
+Values: The name of any city supported by [Wttr.in](http://wttr.in). + +`enabled`
+Determines whether or not this module is executed and if its data displayed onscreen.
+Values: `true`, `false`. + +`position`
+Defines where in the grid this module's widget will be displayed.
+ +`refreshInterval`
+How often, in seconds, this module will update its data.
+Values: A positive integer, `0..n`. + +`unit`
+_Optional_. It will use metric if you are out of US and imperial for US.
+The temperature scale in which to display temperature values.
+Values: `F` for Fahrenheit, `C` for Celcius. + +`view`
+_Optional_ Wttr.in view configuration.
+Values: See `curl wttr.in/:help` for more details. diff --git a/_site/content/posts/modules/security.md b/_site/content/posts/modules/security.md index 2f4a308e..c9800121 100644 --- a/_site/content/posts/modules/security.md +++ b/_site/content/posts/modules/security.md @@ -1,5 +1,5 @@ --- -title: "Modules: Security" +title: "Security" date: 2018-05-08T20:33:28-07:00 draft: false --- diff --git a/_site/content/posts/modules/textfile.md b/_site/content/posts/modules/textfile.md index 1697523f..9db3bd4d 100644 --- a/_site/content/posts/modules/textfile.md +++ b/_site/content/posts/modules/textfile.md @@ -1,5 +1,5 @@ --- -title: "Modules: Textfile" +title: "Textfile" date: 2018-05-09T11:13:11-07:00 draft: false --- diff --git a/_site/content/posts/modules/todo.md b/_site/content/posts/modules/todo.md index 248f956c..b738b67d 100644 --- a/_site/content/posts/modules/todo.md +++ b/_site/content/posts/modules/todo.md @@ -1,5 +1,5 @@ --- -title: "Modules: Todo" +title: "Todo" date: 2018-05-10T12:41:50-07:00 draft: false --- diff --git a/_site/content/posts/modules/weather.md b/_site/content/posts/modules/weather.md index b8b745b3..c7cb5052 100644 --- a/_site/content/posts/modules/weather.md +++ b/_site/content/posts/modules/weather.md @@ -1,5 +1,5 @@ --- -title: "Modules: Weather" +title: "Weather" date: 2018-05-09T11:44:13-07:00 draft: false --- diff --git a/_site/static/imgs/modules/bittrex.png b/_site/static/imgs/modules/bittrex.png new file mode 100644 index 00000000..669139d3 Binary files /dev/null and b/_site/static/imgs/modules/bittrex.png differ diff --git a/_site/static/imgs/modules/blockfolio.png b/_site/static/imgs/modules/blockfolio.png new file mode 100644 index 00000000..1a820c07 Binary files /dev/null and b/_site/static/imgs/modules/blockfolio.png differ diff --git a/_site/static/imgs/modules/circleci.png b/_site/static/imgs/modules/circleci.png new file mode 100644 index 00000000..e2447b41 Binary files /dev/null and b/_site/static/imgs/modules/circleci.png differ diff --git a/_site/static/imgs/modules/cryptolive.png b/_site/static/imgs/modules/cryptolive.png new file mode 100644 index 00000000..d3bd19de Binary files /dev/null and b/_site/static/imgs/modules/cryptolive.png differ diff --git a/_site/static/imgs/modules/gitlab.png b/_site/static/imgs/modules/gitlab.png new file mode 100644 index 00000000..6e806a41 Binary files /dev/null and b/_site/static/imgs/modules/gitlab.png differ diff --git a/_site/static/imgs/modules/ipinfo.png b/_site/static/imgs/modules/ipinfo.png new file mode 100644 index 00000000..45eb5831 Binary files /dev/null and b/_site/static/imgs/modules/ipinfo.png differ diff --git a/_site/static/imgs/modules/jenkins.png b/_site/static/imgs/modules/jenkins.png new file mode 100644 index 00000000..5074eca1 Binary files /dev/null and b/_site/static/imgs/modules/jenkins.png differ diff --git a/_site/static/imgs/modules/prettyweather.png b/_site/static/imgs/modules/prettyweather.png new file mode 100644 index 00000000..77c06b7b Binary files /dev/null and b/_site/static/imgs/modules/prettyweather.png differ diff --git a/_site/themes/hyde-hyde/layouts/index.html b/_site/themes/hyde-hyde/layouts/index.html index 888abc24..d6fed31f 100644 --- a/_site/themes/hyde-hyde/layouts/index.html +++ b/_site/themes/hyde-hyde/layouts/index.html @@ -15,7 +15,7 @@

- Keep an eye on your OpsGenie schedules, Google Calendar, Git + Keep an eye on your OpsGenie schedules, Google Calendar, Git and Github repositories, and New Relic deployments.

@@ -28,8 +28,8 @@

Download Latest - - On Github + Source on Github + Chat on Gitter

diff --git a/_site/themes/hyde-hyde/layouts/partials/sidebar.html b/_site/themes/hyde-hyde/layouts/partials/sidebar.html index b3c4f515..a5b24d6a 100644 --- a/_site/themes/hyde-hyde/layouts/partials/sidebar.html +++ b/_site/themes/hyde-hyde/layouts/partials/sidebar.html @@ -23,15 +23,25 @@