taskboard

TaskBoard

Task organizer, window manager, and time tracker for JIRA items

How to Use

Setup & Basics

1. After following the install instructions, run tb to launch TaskBoard.
2. When launching the first time, TaskBoard will ask where you would like your items directory to be. Each JIRA item gets its own folder in the items directory. Leave it blank to use the default.
3. In TaskBoard, the menu options are at the top of the window. Press the N key to start a new task.
4. Enter the JIRA number or the URL of the JIRA item's page.
5. Enter the name of the task to show in the tasks list.
6. If the task has an associated Pages site repo, enter the GitHub URL or the name of the repo.
7. The task will be added to the list. It will also be set as the active task, denoted by the *.
8. Move through the list with the Up and Down arrow keys, or press a number key to jump to that position.
9. To activate or deactivate a task, press Enter. One task can be active at a time.
10. Press X to remove a task from the list and send its item folder to the Trash.

Time Logging

1. Time spent on each task is recorded while the task is active.
2. To see how much time has been spent on each task, press M for More Options and press T for TimeReport.
3. Enter a start date in the format yyyy-mm-dd or leave blank to use today.
4. Enter an end date in the same format or leave blank to use the same day as start.
5. The time spent on each item will be listed, rounded to the nearest 15 minutes.
6. To log those hours their respective JIRA items, say yes when prompted.
7. Follow the instructions to authorize TimeLog for your JIRA account.
8. Once authorized, time will be logged to each item on JIRA.

NOTE: TimeReport will send all hours for a day to JIRA even if those hours have already been logged. Log your time only once per day!

Apps

TaskBoard can automatically open windows of integrated apps when you start a new task, show and hide them when you switch tasks, and close them when you close a task.

1. To enable or disable an app, press A to open the Apps menu and E to Enable/Disable apps. Enabled apps are denoted by a *.
2. Once an app is enabled, it will appear in the Apps menu. Select it to open a new window for the currently selected task. When a new task is created, enabled apps will open new windows automatically.
3. Switching tasks will hide all windows for the previous task and show all windows for the new task.
4. Closing a task with X will also close all apps for that task.
5. To change the size and position of new app windows, arrange the windows of the active task how you want them, then select Save Window Position in the Apps menu to save the size and position of the selected app.

How to Write App Plugins

You can write your own plugins to integrate more apps. Here are the steps to add a plugin:

1. Make a copy of taskboard/apps/.App Template in taskboard/apps/ and rename it for the new app. The name should be the app's bundle name, which can be found in /Applications/[APP].app/Info.plist. The bundle name is used because it identifies the app in AppleScript.
2. In the new app's folder, activate.sh and new.sh need to be implemented for the new app.
3. bounds.sh, close.sh, and deactivate.sh have default scripts that may already work for the new app. If they don't, they should be implemented as well.
4. Done! Your app can now be enabled in the Apps menu.