1.1.3 • Published 2 years ago

task-time-tracker v1.1.3

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

##A CLI tool to track time spent on tasks.

##Installation:

yarn add task-time-tracker

##Tracking:

Create a file called tasktracker.js in your project directory.

Simply add the following to the file to require the module:

const tasktracker = require('task-time-tracker')

The module will create a database and store the tasks, subtasks and time spent in it. You can name the database whatever you want and can use multiple files to keep track of different categories.

Run the file using the following command but replace <db-name> with the name of the database you want to use:

node tasktracker.js db=<db-name>

Follow the prompts to add tasks, subtasks and time spent. You will initially be prompted to select a task. Here is a list of all available commands:

:done - finish current task
:subtask - start a subtask under the current task
:pause - pause timer
:resume - resume timer
:end - end current subtask
:current - show current task/subtask and state
:add-time - add time to the current task and subtask
:remove-time - remove time from the current task and subtask
:switch-subtask - switch to a different subtask
:switch-task - switch to a different task
:quit - save and quit the program
:help - show this help message

##Reading the data:

To get a readout of the tasks in your database, create a file called readtasks.js in your project directory.

Simply add the following to the file to require the module:

const readtasks = require('task-time-tracker/readtasks')

Then run the file using the following command but replace <db-name> with the name of the database you want to use:

node readtasks.js db=<db-name>

This will print out a list of each task and subtasks in the database.

##Advanced Usage: For more advanced usage of the data collected, the readtasks module returns an instance of the database class described in this documentation: https://www.npmjs.com/package/@ideadesignmedia/db.js

1.1.3

2 years ago

1.1.2

2 years ago

1.1.1

2 years ago

1.1.0

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago