duty.js



Installation

npm install -g duty-js

TESTING

git clone https://github.com/zombieleet/duty

npm install

export NODE_ENV=development

npm test

npm run coverage

npm run showcoverage

usage

To properly setup duty the first thing you should do after installation is to run duty without any argument or subcommand

when no argument is specified, help is outputed

add

This command takes two argument, the todo to add and a category to add the todo into.
The category to add the todo is optional

duty add "go to the dry cleaner"

Some characters a special to the shell. If a category contains space, you have to wrap with in double or single quotes

duty add "go to the dry cleaner" "wash clothes" laundary

append

This command takes two argument, the hash id of a valid todo , and a text to append
All the arguments are compulsory

duty append f82dc15f4 " before mum comes back from work"

replace

This command takes three argument, the hash id of a valid todo , a regular expression to match, a text to replace the matched regular expression
All the arguments are compulsory

duty replace 0476b60de work journey

markcompleted

This command marks a todo as completed, it takes just an argument, which is a valid hash id the todo to mark has completed

duty markcompleted 57c86e40f

note

Add a little note to an already added todo, it takes two argument, a valid hash id of a todo that has already been added and a text which will server as a note.
Both of the arguments are compulsory

duty note 57c86e40f "go back to the dry cleaner to collect the remaining clothe"

removenote

This subcommand removes an already added note. It takes just a single argument which is a valid hash id of a todo

duty removenote 57c86e40f

delete

This subcommand deletes a particular todo, that matches a certain type
supported types are

1. hash < deletes a todo that has the value of hash>
2. completed < deletes all completed todo >
3. category:type < deletes all todo with a type category >
4. date (requires a date argument in this format dd/mm/yyyy) < deletes all todo that matches a specific date >
5. all < removes all todo >

supported for deleting todos

duty delete hash:1591a6d40

duty delete completed

duty delete category:food

duty delete date:dd/mm/yyyy

duty delete all

read

This subcommand prints all added todos that matches a particular type

1. all < reads all todo >
2. date ( takes two argument, the --date option is compulsory , but the --modifiedDate option is not compulsory) < read all todo that matches the specified --date option, if --modifiedDate is specified, it read all todo that has the specified date option and was modified that the the specified modify date option
3. category:type ( reads all todo that belongs to the type category )
4. urgency:type ( read all todo thas have the type urgency)
5. completed ( reads all completed todo)
6. notcompleted ( reads all todo that has not been marked completed)
7. eval

example

duty read all

duty read date --date 14/12/1999

duty read date --date 14/12/1999 --modifiedDate 14/12/2020

duty read category:dutyProject

duty read urgency:pending

duty read urgency:waiting

duty read urgency:tomorrow

duty read urgency:later

duty read urgency:today

duty read eval:"today"

duty read eval:"2 day(s) before now"

duty read eval:"5 day(s) from now"

duty read eval:today

note: The previous way of evaluating todo as string is no longer supported

urgency

This subcommand takes two compulsory argument, the first argument is a valid hash id, while the second argument is an urgency type to set the hash id to
valid urgency types are

1. pending
2. waiting
3. tomorrow
4. later
5. today

example

duty urgency a6bfb2750 urgency:pending

priority

This subcommand takes two compulsory argument, the first argument is a valid hash id, while the second argument is a priority to set the hash id as
Valid priorities are

1. critical
2. notcritical

example

duty priority a6bfb2750 critical

duty priority 8cab293f8 notcritical

categorize

This subcommand takes two argument, a valid hash id to categorize, and a list of category to set the hash id to
Both arguments are compulsory

duty categorize 8cab293f8 dance education learn

due

This subcommand sets a due date for a particular todo. It takes to argument, a valid hash id and a date
Both arguments are compulsory

duty due 8cab293f8 16/04/2017

export

This subcommand requires two argument, it exports all todos to a specific path
The first argument is an export type, while the second argument is the path to export todo to
Valid types are

1. xml
2. html
3. json

example

duty export html /home/victory/duty.html

duty export html /home/victory/duty

duty export xml /home/victory/duty

duty export xml /home/victory/duty.xml

status status subcommand shows you a breakdwon of the todos
duty status

The status subcommand receives at least a single argument, which is all or category. If no argument is specified duty reads all todo

edit edit subcommand edits a todo, this subcommand takes two compulsory arguments

The first argument is the hash of the todo, while the second argument is the text to use

duty edit

help

This subcommand shows all subcommand related to duty.js

NOTE:

hash length that is greater than 4 can be use with any subcommand that requires hash as an argument

what changed in v3.1.0

1. A major bug fix, that causes an EPERM error whenever writing to the config.json file

how to set notification

run sudo duty create-service i.e if you are not root user

Notification is supported on both OSX ( with launchd as it's daemon manager) ( the behaviour is not defined ) and linux ( with systemd daemon manager )

Before the notification feature will work , you have to set the due date of that particular todo

duty due

The date format should be in DD/MM/YYYY

set_notify This subcommand takes three argument

The first argument is the hash value of the todo, the second argument is to set the notification of that hash to be yes or no , the third argument is the timeout of the notification

duty set_notify 23abcdef no 3000 // all the arguments are required, the first argument set_notify sets the notification, the second argument is the hash to work on, the fourth argument ( no ) disables notification, the fifth argument 3000 specifies the timeout of a notification

the daemon method

The daemon method is used by the daemon manager of your O.S , running it from the command line won't do anything special

if you discover any bug , please kindly create an issue or if you want to add something to duty create a pull request. Thanks

BUG

if you encounter an error while running duty after setting up a location to save todos, see issue#4

LICENSE

MIT

GNU ( either version 2 of the License, or (at your option) any later version. )