mirror of
https://github.com/taigrr/wtf
synced 2025-01-18 04:03:14 -08:00
Merge branch 'master' into support-github-enterprise
This commit is contained in:
Amr Tamimi
GitHub
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Modules: Bamboohr"
|
||||
title: "BambooHR"
|
||||
date: 2018-05-07T20:17:37-07:00
|
||||
draft: false
|
||||
---
|
||||
|
||||
53
_site/content/posts/modules/circleci.md
Normal file
53
_site/content/posts/modules/circleci.md
Normal file
@@ -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.
|
||||
|
||||
<img src="/imgs/modules/circleci.png" width="609" height="150" alt="circleci screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/circleci/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
<span class="caption">Key:</span> `WTF_CIRCLE_API_KEY` <br />
|
||||
<span class="caption">Value:</span> Your <a href="https://circleci.com/account/api">CircleCI API</a>
|
||||
token.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
circleci:
|
||||
enabled: true
|
||||
position:
|
||||
top: 4
|
||||
left: 1
|
||||
height: 1
|
||||
width: 2
|
||||
refreshInterval: 900
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`enabled` <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`position` <br />
|
||||
Defines where in the grid this module's widget will be displayed. <br />
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Modules: Clocks"
|
||||
title: "Clocks"
|
||||
date: 2018-05-07T19:47:31-07:00
|
||||
draft: false
|
||||
---
|
||||
|
||||
@@ -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` <br />
|
||||
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` <br />
|
||||
|
||||
87
_site/content/posts/modules/cryptocurrencies/bittrex.md
Normal file
87
_site/content/posts/modules/cryptocurrencies/bittrex.md
Normal file
@@ -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).
|
||||
|
||||
<img src="/imgs/modules/bittrex.png" width="320" height="412" alt="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` <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`colors.base.dispayName` <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`colors.market.name` <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`colors.market.field` <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`colors.market.value` <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`summary` <br />
|
||||
|
||||
`enabled` <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`position` <br />
|
||||
Defines where in the grid this module's widget will be displayed. <br />
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
75
_site/content/posts/modules/cryptocurrencies/blockfolio.md
Normal file
75
_site/content/posts/modules/cryptocurrencies/blockfolio.md
Normal file
@@ -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.
|
||||
|
||||
<img src="/imgs/modules/blockfolio.png" width="320" height="185" alt="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` <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`colors.grows` <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`colors.drop` <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`device_token` <br />
|
||||
Value: See [this gist](https://github.com/bob6664569/blockfolio-api-client) for
|
||||
details on how to get your Blockfolio API token.
|
||||
|
||||
`displayHoldings` <br />
|
||||
|
||||
`enabled` <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`position` <br />
|
||||
Defines where in the grid this module's widget will be displayed. <br />
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
89
_site/content/posts/modules/cryptocurrencies/cryptolive.md
Normal file
89
_site/content/posts/modules/cryptocurrencies/cryptolive.md
Normal file
@@ -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).
|
||||
|
||||
<img src="/imgs/modules/cryptolive.png" width="320" height="203" alt="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` <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`colors.from.dispayName` <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`colors.to.name` <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`colors.to.price` <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`currencies` <br />
|
||||
|
||||
`enabled` <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`position` <br />
|
||||
Defines where in the grid this module's widget will be displayed. <br />
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
@@ -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.
|
||||
|
||||
<img src="/imgs/modules/gcal.png" width="320" height="389" alt="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
|
||||
|
||||
<span class="caption">Key:</span> `WTF_GOOGLE_CAL_CLIENT_ID` <br />
|
||||
<span class="caption">Value:</span> Your <a href="https://developers.google.com/calendar/auth">Google API</a> client ID.
|
||||
|
||||
<span class="caption">Key:</span> `WTF_GOOGLE_CAL_CLIENT_SECRET` <br />
|
||||
<span class="caption">Value:</span> Your <a href="https://developers.google.com/calendar/auth">Google API</a> client secret.
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Modules: Git"
|
||||
title: "Git"
|
||||
date: 2018-05-09T14:20:48-07:00
|
||||
draft: false
|
||||
---
|
||||
|
||||
@@ -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:
|
||||
|
||||
<img src="/imgs/modules/github.png" width="640" height="384" alt="github screenshot" />
|
||||
|
||||
#### Open Review Requests
|
||||
|
||||
@@ -17,6 +15,8 @@ All open code review requests assigned to you.
|
||||
|
||||
All open pull requests created by you.
|
||||
|
||||
<img src="/imgs/modules/github.png" width="640" height="384" alt="github screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
|
||||
90
_site/content/posts/modules/gitlab.md
Normal file
90
_site/content/posts/modules/gitlab.md
Normal file
@@ -0,0 +1,90 @@
|
||||
---
|
||||
title: "Gitlab"
|
||||
date: 2018-06-08T13:14:11-07:00
|
||||
draft: false
|
||||
---
|
||||
|
||||
Added in `v0.0.8`.
|
||||
|
||||
<img src="/imgs/modules/gitlab.png" width="640" height="384" alt="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
|
||||
|
||||
<span class="caption">Key:</span> `WTF_GITLAB_TOKEN` <br />
|
||||
<span class="caption">Action:</span> A <a href="https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html">Gitlab personal access token</a>. Requires at least `api` access.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
<span class="caption">Key:</span> `/` <br />
|
||||
<span class="caption">Action:</span> Open/close the widget's help window.
|
||||
|
||||
<span class="caption">Key:</span> `h` <br />
|
||||
<span class="caption">Action:</span> Show the previous project.
|
||||
|
||||
<span class="caption">Key:</span> `l` <br />
|
||||
<span class="caption">Action:</span> Show the next project.
|
||||
|
||||
<span class="caption">Key:</span> `←` <br />
|
||||
<span class="caption">Action:</span> Show the previous project.
|
||||
|
||||
<span class="caption">Key:</span> `→` <br />
|
||||
<span class="caption">Action:</span> 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` <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`position` <br />
|
||||
Defines where in the grid this module's widget will be displayed. <br />
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
`domain` <br />
|
||||
_Optional_. Your Gitlab corporate domain. <br />
|
||||
Values: A valid URI.
|
||||
|
||||
`projects` <br />
|
||||
A list of key/value pairs each describing a Gitlab project to fetch data
|
||||
for. <br />
|
||||
<span class="caption">Key:</span> The name of the project. <br />
|
||||
<span class="caption">Value:</span> The namespace of the project.
|
||||
|
||||
`username` <br />
|
||||
Your Gitlab username. Used to figure out which requests require your approval
|
||||
70
_site/content/posts/modules/gspreadsheet.md
Normal file
70
_site/content/posts/modules/gspreadsheet.md
Normal file
@@ -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` <br />
|
||||
The color to display the cell values in. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
|
||||
|
||||
`cells.names` <br />
|
||||
|
||||
`cells.addresses` <br />
|
||||
|
||||
`enabled` <br />
|
||||
Whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`position` <br />
|
||||
Where in the grid this module's widget will be displayed. <br />
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
`secretFile` <br />
|
||||
Your <a href="https://developers.google.com/sheets/api/quickstart/go">Google client secret</a> JSON file. <br />
|
||||
Values: A string representing a file path to the JSON secret file.
|
||||
62
_site/content/posts/modules/ipapi.md
Normal file
62
_site/content/posts/modules/ipapi.md
Normal file
@@ -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` <br />
|
||||
The default colour for the row names. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
|
||||
|
||||
`colors.value` <br />
|
||||
The default colour for the row values. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
|
||||
|
||||
`enabled` <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`position` <br />
|
||||
Defines where in the grid this module's widget will be displayed. <br />
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
62
_site/content/posts/modules/ipinfo.md
Normal file
62
_site/content/posts/modules/ipinfo.md
Normal file
@@ -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.
|
||||
|
||||
<img src="/imgs/modules/ipinfo.png" width="320" height="199" alt="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` <br />
|
||||
The default colour for the row names. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
|
||||
|
||||
`colors.value` <br />
|
||||
The default colour for the row values. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
|
||||
|
||||
`enabled` <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`position` <br />
|
||||
Defines where in the grid this module's widget will be displayed. <br />
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
63
_site/content/posts/modules/jenkins.md
Normal file
63
_site/content/posts/modules/jenkins.md
Normal file
@@ -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
|
||||
|
||||
<img src="/imgs/modules/jenkins.png" alt="jenkins screenshot",
|
||||
width="320" height="68" alt="jenkins screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/jenkins/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
<span class="caption">Key:</span> `WTF_JENKINS_API_KEY` <br />
|
||||
<span class="caption">Value:</span> Your <a href="https://wiki.jenkins.io/display/JENKINS/Remote+access+API">Jenkins API</a> 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` <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`position` <br />
|
||||
Defines where in the grid this module's widget will be displayed.
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
`user` <br />
|
||||
Your Jenkins username. <br />
|
||||
|
||||
`url` <br />
|
||||
The url to your Jenkins project or view. <br />
|
||||
Values: A valid URI.
|
||||
|
||||
@@ -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. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`jql` <br />
|
||||
_Optional_ <br />
|
||||
Custom JQL to be appended to the search query. <br />
|
||||
Values: See <a href="https://confluence.atlassian.com/jiracore/blog/2015/07/search-jira-like-a-boss-with-jql">Search Jira like a boss with JQL</a> for details.
|
||||
|
||||
`position` <br />
|
||||
Defines where in the grid this module's widget will be displayed. <br />
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Modules: New Relic"
|
||||
title: "New Relic"
|
||||
date: 2018-05-09T09:01:14-07:00
|
||||
draft: false
|
||||
---
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Modules: OpsGenie"
|
||||
title: "OpsGenie"
|
||||
date: 2018-05-08T20:53:40-07:00
|
||||
draft: false
|
||||
---
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Modules: Power"
|
||||
title: "Power"
|
||||
date: 2018-05-26T19:26:23-07:00
|
||||
draft: false
|
||||
---
|
||||
|
||||
67
_site/content/posts/modules/prettyweather.md
Normal file
67
_site/content/posts/modules/prettyweather.md
Normal file
@@ -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).
|
||||
|
||||
<img src="/imgs/modules/prettyweather.png" width="320" height="191" alt="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` <br />
|
||||
_Optional_. It will grab the current location from your IP address if
|
||||
omitted.<br />
|
||||
Values: The name of any city supported by [Wttr.in](http://wttr.in).
|
||||
|
||||
`enabled` <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`position` <br />
|
||||
Defines where in the grid this module's widget will be displayed. <br />
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
`unit` <br />
|
||||
_Optional_. It will use metric if you are out of US and imperial for US.<br />
|
||||
The temperature scale in which to display temperature values. <br />
|
||||
Values: `F` for Fahrenheit, `C` for Celcius.
|
||||
|
||||
`view` <br />
|
||||
_Optional_ Wttr.in view configuration. <br />
|
||||
Values: See `curl wttr.in/:help` for more details.
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Modules: Security"
|
||||
title: "Security"
|
||||
date: 2018-05-08T20:33:28-07:00
|
||||
draft: false
|
||||
---
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Modules: Textfile"
|
||||
title: "Textfile"
|
||||
date: 2018-05-09T11:13:11-07:00
|
||||
draft: false
|
||||
---
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Modules: Todo"
|
||||
title: "Todo"
|
||||
date: 2018-05-10T12:41:50-07:00
|
||||
draft: false
|
||||
---
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Modules: Weather"
|
||||
title: "Weather"
|
||||
date: 2018-05-09T11:44:13-07:00
|
||||
draft: false
|
||||
---
|
||||
|
||||
Reference in New Issue
Block a user