View on GitHub

duke

User Guide

Introduction

Duke is an offline application for managing various tasks. It is optimised for those who prefer to work with a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI).

Features

Command Format

Add a task

Duke can track three types of tasks:

Examples:

<todo borrow book>
__________
Got it. I've added this task: 
       [T][✗] borrow book
     Now you have 5 tasks in the list.
__________
<deadline CS2106 assignment /by 18/08/2019 2359>
__________
Got it. I've added this task: 
       [D][✗] return book (by: 18/08/2019 2359hrs)
     Now you have 6 tasks in the list.
__________
<event birthday party /at 13/09/2019 1500 to 13/09/2019 2000
__________
Got it. I've added this task: 
           [E][✗] birthday party (at: 13/09/2019 1500hrs to 13/09/2019 2000hrs)
         Now you have 7 tasks in the list.

List tasks

To list all the tasks in Duke:

list

Complete a task

The default status of a task added on Duke is incomplete: [✘] To mark a task as done:

done INDEX This would subsequently update the status of the task to *completed*: [✓].

Example:

<list>
__________
Here are the tasks in your list:
    1. [T][✘] read book
    2. [D][✘] return book (by: 18/07/2019 1800hrs)
__________
<done 2>
__________
Nice! I've marked this task as done: 
       [✓] return book
__________
<list>
___________
Here are the tasks in your list:
    1. [T][✓] read book
    2. [D][✘] return book (by: 18/07/2019 1800hrs)

Delete a task

To delete a task in Duke:

delete INDEX

Example:

<list>
__________
Here are the tasks in your list:
     1.[T][✓] read book
     2.[D][✓] return book (by: 6/06/2019 1500hrs)
     3.[E][✗] project meeting (at: 9/12/2020 1330hrs to 9/12/2020 1500hrs)
     4.[T][✓] join sports club
     5.[T][✗] borrow book
__________
<delete 3>
__________
Noted. I've removed this task: 
       [E][✗] project meeting (at: 9/12/2020 1330hrs)
Now you have 4 tasks in the list.

Save a task

Duke saves tasks in a hard disk automatically whenever the task list changes. It loads the data from the hard disk when it starts up.

Find a task

To look for a task by keyword in Duke:

find KEYWORD

Example:

<find book>
__________
Here are the matching tasks in your list:
     1.[T][✓] read book
     2.[D][✓] return book (by: 18/09/2018 1735hrs)

Edit a task

The editable attributes of a task are:

  1. des : the description of a task
  2. date : the date of event and deadline tasks.
edit INDEX/ATTRIBUTE/NEW ATTRIBUTE

Note that to edit the date of event and deadline tasks, the format is

Task Type Command
Event edit INDEX/date/DATE TIME to DATE TIME
Deadline edit INDEX/date/DATE TIME

Examples:

<list>
__________
Here are the tasks in your list:
         1.[T][✓] read book
         2.[D][✓] return book (by: 6/06/2019 1500hrs)
         3.[E][✗] project meeting (at: 9/12/2020 1330hrs to 9/12/2020 1500hrs)
         4.[T][✓] join sports club
         5.[T][✗] borrow book
__________
<edit 3/date/18/09/2019 1800 to 18/09/2019 1900>
__________
Success! I've edited this task from this:
[E][✗] project meeting (at: 9/12/2020 1330hrs to 9/12/2020 1500hrs)
to this:
[E][✗] project meeting (at: 18/09/2019 1800hrs to 18/09/2019 1900hrs)
 __________
 <edit 4/des/join arts club>
 __________
 Success! I've edited this task from this:
 [T][✓] join sports club
 to this:
 [T][✓] join arts club

Exit Duke

To exit Duke and close the programme:

bye