idt-slack-goals

CLI tool for IDoneThis with ability to post your list of goals to Slack.

>  idt --help

  Usage: idt-slack-goals [options] [command]

  Commands:

    complete <search>  Marks the first goal matched by the search as complete.
    done <entry>       Adds an item to your list of accomplishments in IDoneThis.
    goal <entry>       Adds an item to your list of goals in IDoneThis.
    slack [type]       Posts your list of IDoneThis goals for today in Slack.
    list               Lists your goals and accomplishments in IDoneThis for today.

  Options:

    -h, --help     output usage information
    -V, --version  output the version number

>  idt goal 'Standup'
◻️  Standup

>  idt goal 'Sync up with Jordan re bug'
◻️  Sync up with Jordan re bug
◻️  Standup

>  idt goal 'Review all assigned PRs'
◻️  Review all assigned PRs
◻️  Sync up with Jordan re bug
◻️  Standup

>  idt goal 'Refactor repo'
◻️  Refactor repo
◻️  Review all assigned PRs
◻️  Sync up with Jordan re bug
◻️  Standup

>  idt list
◻️  Refactor repo
◻️  Review all assigned PRs
◻️  Sync up with Jordan re bug
◻️  Standup

>  idt complete 'jordan'
◻️  Refactor repo
◻️  Review all assigned PRs
☑️  Sync up Jordan re bug
◻️  Standup

>  idt done 'Make coffee'
☑️  Make coffee
◻️  Refactor repo
◻️  Review all assigned PRs
☑️  Sync up Jordan re bug
◻️  Standup

>  idt slack
☑️  Make coffee
◻️  Refactor repo
◻️  Review all assigned PRs
☑️  Sync up Jordan re bug
◻️  Standup

Installation

npm install -g idt-slack-goals

Environment Setup

Define the following environment variables in your shell profile.

IDT_TEAM_ID

In order to obtain your team ID in IDoneThis:

1. Log into IDoneThis.

2. You should be directed to a screen where you can see your and your teammates' tasks.

3. Your team ID is the last parameter in the URL.

   For example, if the URL is:

   https://beta.idonethis.com/t/123456789
   

   Then your team ID is 123456789.

IDT_USER_ID

In order to obtain your user ID in IDoneThis:

1. Log into IDoneThis.

2. You should be directed to a screen where you can see your and your teammates' tasks.

3. Click on your avatar to visit your profile.

4. Your user ID is the last parameter in the URL.

   For example, if the URL is:

   https://beta.idonethis.com/o/123456789/u/987654321
   

   Then your user ID is 987654321.

IDT_TOKEN

To obtain your IDoneThis API token:

1. Log into IDoneThis.

2. Click Account settings in the navigation on the left.

3. Scroll to the API Token section.

4. Your API token appears in a text field.

IDT_SLACK_HOOK

To obtain a Slack WebHook URL:

1. Log into the Slack web interface.

2. Visit the Incoming WebHooks app page.

3. Click Add Configuration.

4. Choose a channel to post your IDoneThis update into.

5. Your Slack hook will be the part of the Webhook URL after https://hooks.slack.com/services/.

   For example, if your Webhook URL is:

   https://hooks.slack.com/services/ABCD123456/DEFG789012/HIJK345678
   

   Then your Slack hook is ABCD123456/DEFG789012/HIJK345678.

Usage

For brevity, you may want to add this to your shell profile:

alias idt="idt-slack-goals"

The examples below will assume you are using the alias; if not, replace idt with idt-slack-goals.

List all goals and accomplishments

This will print all incomplete goals as well as entries you've accomplished today to the console.

idt list

Post your list of goals and accomplishments on Slack

This will post your goals and accomplishments in Slack.

idt slack

Post only goals on Slack

You may pass goal or done to the Slack command to only post goals or accomplishments in the Slack channel, respectively.

idt slack goal

Add a goal

Add a goal for today.

idt goal 'Write unit tests'

Add a task you've already completed

Add an entry that is already done.

idt done 'Fixed bug on autocomplete widget'

Mark an existing task as completed

This will locate the first goal for today that contains the given string and mark it as completed.

idt complete 'unit test'