diff --git a/_site/content/posts/modules/bamboohr.md b/_site/content/posts/modules/bamboohr.md index 2ca3e35f..6d75f242 100644 --- a/_site/content/posts/modules/bamboohr.md +++ b/_site/content/posts/modules/bamboohr.md @@ -12,14 +12,6 @@ Connects to the BambooHR API and displays who will be Away today. wtf/bamboohr/ ``` -## Required ENV Variables - -Key: `WTF_BAMBOO_HR_TOKEN`
-Value: Your BambooHR API token. - -Key: `WTF_BAMBOO_HR_SUBDOMAIN`
-Value: Your BambooHR API subdomain name. - ## Keyboard Commands None. @@ -28,6 +20,7 @@ None. ```yaml bamboohr: + apiKey: "3276d7155dd9ee27b8b14f8743a408a9" enabled: true position: top: 0 @@ -35,12 +28,16 @@ bamboohr: height: 2 width: 1 refreshInterval: 900 + subdomain: "testco" ``` ### Attributes +`apiKey`
+Value: Your BambooHR API token. + `enabled`
-Determines whether or not this module is executed and if its data displayed onscreen.
+Whether or not this module is executed and if its data displayed onscreen.
Values: `true`, `false`. `position`
@@ -49,3 +46,6 @@ Defines where in the grid this module's widget will be displayed.
`refreshInterval`
How often, in seconds, this module will update its data.
Values: Any positive integer, `0..n`. + +`subdomain`
+Value: Your BambooHR API subdomain name. diff --git a/_site/content/posts/modules/github.md b/_site/content/posts/modules/github.md index 3c54b776..bc80f930 100644 --- a/_site/content/posts/modules/github.md +++ b/_site/content/posts/modules/github.md @@ -23,22 +23,6 @@ All open pull requests created by you. wtf/github/ ``` -## GitHub Required ENV Variables - -Key: `WTF_GITHUB_TOKEN`
-Action: Your GitHub API token. - -## GitHub Enterprise Required ENV Variables - -Key: `WTF_GITHUB_TOKEN`
-Action: Your GitHub API token. - -Key: `WTF_GITHUB_BASE_URL`
-Action: Your GitHub Enterprise API URL. - -Key: `WTF_GITHUB_UPLOAD_URL`
-Action: Your GitHub Enterprise upload URL (often the same as API URL). - ## Keyboard Commands Key: `/`
@@ -60,6 +44,8 @@ wtf/github/ ```yaml github: + apiKey: "3276d7155dd9ee27b8b14f8743a408a9" + baseURL: "" enabled: true enableStatus: true position: @@ -71,13 +57,21 @@ github: repositories: wesker-api: "UmbrellaCorp" wtf: "senorprogrammer" + uploadURL: "" username: "senorprogrammer" ``` ### Attributes +`apiKey`
+Value: Your GitHub API token. + +`baseURL`
+_Optional_
+Value: Your GitHub Enterprise API URL. + `enabled`
-Determines whether or not this module is executed and if its data displayed onscreen.
+Whether or not this module is executed and if its data displayed onscreen.
Values: `true`, `false`. `enableStatus`
@@ -98,6 +92,10 @@ for.
Key: The name of the repository.
Value: The name of the account or organization that owns the repository. +`uploadURL`
+_Optional_
+Value: Your GitHub Enterprise upload URL (often the same as API URL). + `username`
Your GitHub username. Used to figure out which review requests you've been added to. diff --git a/_site/content/posts/modules/jira.md b/_site/content/posts/modules/jira.md index 081f4a31..71a6f988 100644 --- a/_site/content/posts/modules/jira.md +++ b/_site/content/posts/modules/jira.md @@ -14,11 +14,6 @@ Displays all Jira issues assigned to you for the specified project. wtf/jira/ ``` -## Required ENV Variables - -Key: `WTF_JIRA_API_KEY`
-Value: Your Jira API key. - ## Keyboard Commands Key: `[return]`
@@ -42,6 +37,7 @@ wtf/jira/ ```yaml jira: + apiKey: "3276d7155dd9ee27b8b14f8743a408a9" colors: rows: even: "lightblue" @@ -68,6 +64,7 @@ configuration (note the difference in `project`): ```yaml jira: + apiKey: "3276d7155dd9ee27b8b14f8743a408a9" colors: rows: even: "lightblue" @@ -89,6 +86,9 @@ jira: ### Attributes +`apiKey`
+Value: Your Jira API key. + `colors.rows.even`
Define the foreground color for even-numbered rows.
Values: Any X11 diff --git a/_site/content/posts/modules/newrelic.md b/_site/content/posts/modules/newrelic.md index e7eb1fbc..9d2881d3 100644 --- a/_site/content/posts/modules/newrelic.md +++ b/_site/content/posts/modules/newrelic.md @@ -15,12 +15,6 @@ monitored application: deploy ID, deploy time, and who deployed it. wtf/newrelic/ ``` -## Required ENV Variables - -Key: `WTF_NEW_RELIC_API_KEY`
-Value: Your
New Relic API -token. - ## Keyboard Commands None. @@ -29,6 +23,7 @@ None. ```yaml newrelic: + apiKey: "3276d7155dd9ee27b8b14f8743a408a9" applicationId: 10549735 deployCount: 6 enabled: true @@ -42,6 +37,9 @@ newrelic: ### Attributes +`apiKey`
+Value: Your New Relic API token. + `applicationId`
The integer ID of the New Relic application you wish to report on.
diff --git a/_site/content/posts/modules/opsgenie.md b/_site/content/posts/modules/opsgenie.md index 5d34d4be..ac18411b 100644 --- a/_site/content/posts/modules/opsgenie.md +++ b/_site/content/posts/modules/opsgenie.md @@ -15,12 +15,6 @@ and who's currently on call. wtf/opsgenie/ ``` -## Required ENV Variables - -Key: `WTF_OPS_GENIE_API_KEY`
-Value: Your OpsGenie -API token. - ## Keyboard Commands None. @@ -29,6 +23,7 @@ None. ```yaml opsgenie: + apiKey: "3276d7155dd9ee27b8b14f8743a408a9" displayEmpty: false enabled: true position: @@ -41,6 +36,9 @@ opsgenie: ### Attributes +`apiKey` < br /> +Value: Your OpsGenie API token. + `displayEmpty`
Whether schedules with no assigned person on-call should be displayed.
Values: `true`, `false`. diff --git a/_site/content/posts/modules/todoist.md b/_site/content/posts/modules/todoist.md index 9381b5b8..9326313d 100644 --- a/_site/content/posts/modules/todoist.md +++ b/_site/content/posts/modules/todoist.md @@ -16,13 +16,6 @@ Displays all items on specified project. wtf/todoist/ ``` -## Required ENV Variables - -Key: `WTF_TODOIST_TOKEN`
-Value: Your Todoist API Token.
- -_You can get your API Token at: todoist.com/prefs/integrations._ - ## Keyboard Commands Key: `h`
@@ -62,6 +55,7 @@ _You can get your API Token at: todoist.com/prefs/integrations._ ```yaml todoist: + apiKey: "3276d7155dd9ee27b8b14f8743a408a9" enabled: true position: top: 0 @@ -75,6 +69,9 @@ todoist: ### Attributes +`apiKey`
+Value: Your Todoist API token. + `enabled`
Determines whether or not this module is executed and if its data displayed onscreen.
Values: `true`, `false`. diff --git a/docs/index.xml b/docs/index.xml index 5a8d124a..c36ed99b 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -49,12 +49,13 @@ position Defines where in the grid this module&rsquo;s widget will be displa https://wtfutil.com/posts/modules/todoist/ Added in v0.0.11. Displays all items on specified project. -Source Code wtf/todoist/ Required ENV Variables Key: WTF_TODOIST_TOKEN Value: Your Todoist API Token. You can get your API Token at: todoist.com/prefs/integrations. -Keyboard Commands Key: h Action: Show the previous project. +Source Code wtf/todoist/ Keyboard Commands Key: h Action: Show the previous project. Key: ← Action: Show the previous project. Key: l Action: Show the next project. Key: → Action: Show the next project. -Key: j Action: Select the next item in the list. +Key: j Action: Select the next item in the list. +Key: ↓ Action: Select the next item in the list. +Key: k Action: Select the previous item in the list. @@ -339,12 +340,12 @@ Key: j Action: Select the next item in the list. https://wtfutil.com/posts/modules/jira/ Displays all Jira issues assigned to you for the specified project. -Source Code wtf/jira/ Required ENV Variables Key: WTF_JIRA_API_KEY Value: Your Jira API key. -Keyboard Commands Key: [return] Action: Open the selected issue in the browser. +Source Code wtf/jira/ Keyboard Commands Key: [return] Action: Open the selected issue in the browser. Key: j Action: Select the next item in the list. Key: k Action: Select the previous item in the list. Key: ↓ Action: Select the next item in the list. -Key: ↑ Action: Select the previous item in the list. +Key: ↑ Action: Select the previous item in the list. +Configuration Single Jira Project jira:apiKey:&#34;3276d7155dd9ee27b8b14f8743a408a9&#34;colors:rows:even:&#34;lightblue&#34;odd:&#34;white&#34;domain:&#34;https://umbrellacorp. @@ -382,10 +383,11 @@ Configuration gcal:colors:title:&#34;red&#34;description:&#34;lightb Displays information about your git repositories hosted on GitHub: Open Review Requests All open code review requests assigned to you. Open Pull Requests All open pull requests created by you. -Source Code wtf/github/ GitHub Required ENV Variables Key: WTF_GITHUB_TOKEN Action: Your GitHub API token. -GitHub Enterprise Required ENV Variables Key: WTF_GITHUB_TOKEN Action: Your GitHub API token. -Key: WTF_GITHUB_BASE_URL Action: Your GitHub Enterprise API URL. -Key: WTF_GITHUB_UPLOAD_URL Action: Your GitHub Enterprise upload URL (often the same as API URL). +Source Code wtf/github/ Keyboard Commands Key: / Action: Open/close the widget&rsquo;s help window. +Key: h Action: Show the previous git repository. +Key: l Action: Show the next git repository. +Key: ← Action: Show the previous git repository. +Key: → Action: Show the next git repository. @@ -438,10 +440,10 @@ filePath The path to the file to be displayed in the widget. https://wtfutil.com/posts/modules/newrelic/ Connects to the New Relic API and displays the last n deploys of the monitored application: deploy ID, deploy time, and who deployed it. -Source Code wtf/newrelic/ Required ENV Variables Key: WTF_NEW_RELIC_API_KEY Value: Your New Relic API token. -Keyboard Commands None. -Configuration newrelic:applicationId:10549735deployCount:6enabled:trueposition:top:4left:3height:1width:2refreshInterval:900 Attributes applicationId The integer ID of the New Relic application you wish to report on. Values: A positive integer, 0..n. -deployCount The number of past deploys to display on screen. +Source Code wtf/newrelic/ Keyboard Commands None. +Configuration newrelic:apiKey:&#34;3276d7155dd9ee27b8b14f8743a408a9&#34;applicationId:10549735deployCount:6enabled:trueposition:top:4left:3height:1width:2refreshInterval:900 Attributes apiKey Value: Your New Relic API token. +applicationId The integer ID of the New Relic application you wish to report on. Values: A positive integer, 0..n. +deployCount The number of past deploys to display on screen. Values: A positive integer, 0. @@ -451,9 +453,9 @@ deployCount The number of past deploys to display on screen. https://wtfutil.com/posts/modules/opsgenie/ Connects to the OpsGenie API and displays all your scheduled rotations and who&rsquo;s currently on call. -Source Code wtf/opsgenie/ Required ENV Variables Key: WTF_OPS_GENIE_API_KEY Value: Your OpsGenie API token. -Keyboard Commands None. -Configuration opsgenie:displayEmpty:falseenabled:trueposition:top:2left:1height:2width:1refreshInterval:21600 Attributes displayEmpty Whether schedules with no assigned person on-call should be displayed. Values: true, false. +Source Code wtf/opsgenie/ Keyboard Commands None. +Configuration opsgenie:apiKey:&#34;3276d7155dd9ee27b8b14f8743a408a9&#34;displayEmpty:falseenabled:trueposition:top:2left:1height:2width:1refreshInterval:21600 Attributes apiKey &lt; br /&gt; Value: Your OpsGenie API token. +displayEmpty Whether schedules with no assigned person on-call should be displayed. Values: true, false. enabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false. position Where in the grid this module&rsquo;s widget will be displayed. @@ -475,11 +477,10 @@ Wifi Network The name of the current network Whether or not the network uses enc https://wtfutil.com/posts/modules/bamboohr/ Connects to the BambooHR API and displays who will be Away today. -Source Code wtf/bamboohr/ Required ENV Variables Key: WTF_BAMBOO_HR_TOKEN Value: Your BambooHR API token. -Key: WTF_BAMBOO_HR_SUBDOMAIN Value: Your BambooHR API subdomain name. -Keyboard Commands None. -Configuration bamboohr:enabled:trueposition:top:0left:1height:2width:1refreshInterval: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&rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. +Source Code wtf/bamboohr/ Keyboard Commands None. +Configuration bamboohr:apiKey:&#34;3276d7155dd9ee27b8b14f8743a408a9&#34;enabled:trueposition:top:0left:1height:2width:1refreshInterval:900subdomain:&#34;testco&#34; Attributes apiKey Value: Your BambooHR API token. +enabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false. +position Defines where in the grid this module&rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: Any positive integer, 0. diff --git a/docs/posts/index.xml b/docs/posts/index.xml index 1f86265b..24b26896 100644 --- a/docs/posts/index.xml +++ b/docs/posts/index.xml @@ -49,12 +49,13 @@ position Defines where in the grid this module&rsquo;s widget will be displa https://wtfutil.com/posts/modules/todoist/ Added in v0.0.11. Displays all items on specified project. -Source Code wtf/todoist/ Required ENV Variables Key: WTF_TODOIST_TOKEN Value: Your Todoist API Token. You can get your API Token at: todoist.com/prefs/integrations. -Keyboard Commands Key: h Action: Show the previous project. +Source Code wtf/todoist/ Keyboard Commands Key: h Action: Show the previous project. Key: ← Action: Show the previous project. Key: l Action: Show the next project. Key: → Action: Show the next project. -Key: j Action: Select the next item in the list. +Key: j Action: Select the next item in the list. +Key: ↓ Action: Select the next item in the list. +Key: k Action: Select the previous item in the list. @@ -339,12 +340,12 @@ Key: j Action: Select the next item in the list. https://wtfutil.com/posts/modules/jira/ Displays all Jira issues assigned to you for the specified project. -Source Code wtf/jira/ Required ENV Variables Key: WTF_JIRA_API_KEY Value: Your Jira API key. -Keyboard Commands Key: [return] Action: Open the selected issue in the browser. +Source Code wtf/jira/ Keyboard Commands Key: [return] Action: Open the selected issue in the browser. Key: j Action: Select the next item in the list. Key: k Action: Select the previous item in the list. Key: ↓ Action: Select the next item in the list. -Key: ↑ Action: Select the previous item in the list. +Key: ↑ Action: Select the previous item in the list. +Configuration Single Jira Project jira:apiKey:&#34;3276d7155dd9ee27b8b14f8743a408a9&#34;colors:rows:even:&#34;lightblue&#34;odd:&#34;white&#34;domain:&#34;https://umbrellacorp. @@ -382,10 +383,11 @@ Configuration gcal:colors:title:&#34;red&#34;description:&#34;lightb Displays information about your git repositories hosted on GitHub: Open Review Requests All open code review requests assigned to you. Open Pull Requests All open pull requests created by you. -Source Code wtf/github/ GitHub Required ENV Variables Key: WTF_GITHUB_TOKEN Action: Your GitHub API token. -GitHub Enterprise Required ENV Variables Key: WTF_GITHUB_TOKEN Action: Your GitHub API token. -Key: WTF_GITHUB_BASE_URL Action: Your GitHub Enterprise API URL. -Key: WTF_GITHUB_UPLOAD_URL Action: Your GitHub Enterprise upload URL (often the same as API URL). +Source Code wtf/github/ Keyboard Commands Key: / Action: Open/close the widget&rsquo;s help window. +Key: h Action: Show the previous git repository. +Key: l Action: Show the next git repository. +Key: ← Action: Show the previous git repository. +Key: → Action: Show the next git repository. @@ -438,10 +440,10 @@ filePath The path to the file to be displayed in the widget. https://wtfutil.com/posts/modules/newrelic/ Connects to the New Relic API and displays the last n deploys of the monitored application: deploy ID, deploy time, and who deployed it. -Source Code wtf/newrelic/ Required ENV Variables Key: WTF_NEW_RELIC_API_KEY Value: Your New Relic API token. -Keyboard Commands None. -Configuration newrelic:applicationId:10549735deployCount:6enabled:trueposition:top:4left:3height:1width:2refreshInterval:900 Attributes applicationId The integer ID of the New Relic application you wish to report on. Values: A positive integer, 0..n. -deployCount The number of past deploys to display on screen. +Source Code wtf/newrelic/ Keyboard Commands None. +Configuration newrelic:apiKey:&#34;3276d7155dd9ee27b8b14f8743a408a9&#34;applicationId:10549735deployCount:6enabled:trueposition:top:4left:3height:1width:2refreshInterval:900 Attributes apiKey Value: Your New Relic API token. +applicationId The integer ID of the New Relic application you wish to report on. Values: A positive integer, 0..n. +deployCount The number of past deploys to display on screen. Values: A positive integer, 0. @@ -451,9 +453,9 @@ deployCount The number of past deploys to display on screen. https://wtfutil.com/posts/modules/opsgenie/ Connects to the OpsGenie API and displays all your scheduled rotations and who&rsquo;s currently on call. -Source Code wtf/opsgenie/ Required ENV Variables Key: WTF_OPS_GENIE_API_KEY Value: Your OpsGenie API token. -Keyboard Commands None. -Configuration opsgenie:displayEmpty:falseenabled:trueposition:top:2left:1height:2width:1refreshInterval:21600 Attributes displayEmpty Whether schedules with no assigned person on-call should be displayed. Values: true, false. +Source Code wtf/opsgenie/ Keyboard Commands None. +Configuration opsgenie:apiKey:&#34;3276d7155dd9ee27b8b14f8743a408a9&#34;displayEmpty:falseenabled:trueposition:top:2left:1height:2width:1refreshInterval:21600 Attributes apiKey &lt; br /&gt; Value: Your OpsGenie API token. +displayEmpty Whether schedules with no assigned person on-call should be displayed. Values: true, false. enabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false. position Where in the grid this module&rsquo;s widget will be displayed. @@ -475,11 +477,10 @@ Wifi Network The name of the current network Whether or not the network uses enc https://wtfutil.com/posts/modules/bamboohr/ Connects to the BambooHR API and displays who will be Away today. -Source Code wtf/bamboohr/ Required ENV Variables Key: WTF_BAMBOO_HR_TOKEN Value: Your BambooHR API token. -Key: WTF_BAMBOO_HR_SUBDOMAIN Value: Your BambooHR API subdomain name. -Keyboard Commands None. -Configuration bamboohr:enabled:trueposition:top:0left:1height:2width:1refreshInterval: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&rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. +Source Code wtf/bamboohr/ Keyboard Commands None. +Configuration bamboohr:apiKey:&#34;3276d7155dd9ee27b8b14f8743a408a9&#34;enabled:trueposition:top:0left:1height:2width:1refreshInterval:900subdomain:&#34;testco&#34; Attributes apiKey Value: Your BambooHR API token. +enabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false. +position Defines where in the grid this module&rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: Any positive integer, 0. diff --git a/docs/posts/modules/bamboohr/index.html b/docs/posts/modules/bamboohr/index.html index f3b3a664..efe6ef24 100644 --- a/docs/posts/modules/bamboohr/index.html +++ b/docs/posts/modules/bamboohr/index.html @@ -141,31 +141,28 @@ height="0" width="0" style="display:none;visibility:hidden">

Source Code

wtf/bamboohr/
-

Required ENV Variables

- -

Key: WTF_BAMBOO_HR_TOKEN
-Value: Your BambooHR API token.

- -

Key: WTF_BAMBOO_HR_SUBDOMAIN
-Value: Your BambooHR API subdomain name.

-

Keyboard Commands

None.

Configuration

bamboohr:
+  apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
   enabled: true
   position:
     top: 0
     left: 1
     height: 2
     width: 1
-  refreshInterval: 900
+ refreshInterval: 900 + subdomain: "testco"

Attributes

+

apiKey
+Value: Your BambooHR API token.

+

enabled
-Determines whether or not this module is executed and if its data displayed onscreen.
+Whether or not this module is executed and if its data displayed onscreen.
Values: true, false.

position
@@ -175,6 +172,9 @@ Defines where in the grid this module’s widget will be displayed.
Values: Any positive integer, 0..n.

+

subdomain
+Value: Your BambooHR API subdomain name.

+