Duke User Guide

Duke is a desktop application for managing tasks using Command Line Interface.

Quick start

1. Ensure that your computer has java 11 installed.

2. Download the latest ip.jar.

3. Copy the jar file to an empty folder you want to use as the home folder for Duke.

4. Navigate to the folder containing the jar file on command prompt and run the command java -jar ip.jar.

5. Type in a command and press Enter to execute it.

6. Refer to the Features below for details of each command.

Features

Note:

• Words in UPPER_CASE are parameters that the user needs to supply.
  • e.g. todo DESCRIPTION, DESCRIPTION is a parameter which can be used as todo buy bread.
• Commands and parameter indicators are case-sensitive.
  • e.g. list will show a list of all tasks in Duke but List would throw an invalid command error.
  • e.g. /at indicates that whatever follows it will be event timing while \At will throw an error stating that the event time is not given.

Adding a todo: todo

Adds a todo, a task without any date/time attached, to Duke.

Format: todo DESCRIPTION

Example of usage: todo buy bread

Expected outcome:
Got it. I've added this task:
  [T][N] read book
Now you have 1 task(s) in the list.

Adding a deadline: deadline

Adds a deadline, a task that needs to be done before a specific time/date, to Duke.

Format: deadline DESCRIPTION /by TIME_IT_IS_DUE_BY

Example of usage: deadline return book /by Sunday 1pm

Expected outcome:
Got it. I've added this task:
  [D][N] return book (by: Sunday 1pm)
Now you have 2 task(s) in the list.

Adding an event: event

Adds an event, a task that starts at a specific time and ends at a specific time, to Duke.

Format: event DESCRIPTION /at EVENT_TIMING

Example of usage:event meeting /at 30/10/2020 1300-1400

Expected outcome:
Got it. I've added this task:
  [E][N] meeting (at: 30/10/2020 1300-1400)
Now you have 2 task(s) in the list.

Listing all tasks: list

Shows a list of all tasks in Duke.

Format: list

Example of usage: list

Expected outcome:
Here are the tasks in your list:
  [T][N] read book
  [D][N] return book (by: Sunday 1pm)
  [E][N] meeting (at: 30/10/2020 1300-1400)

Deleting a task: delete

Deletes the specified task from Duke.

Format: delete TASK_INDEX

• Deletes the task at the specified TASK_INDEX.
• The TASK_INDEX refers to the task number shown in the displayed task list.
• The TASK_INDEX must be a positive integer greater than 0.

Example of usage: delete 2

Expected outcome:
Noted. I've removed this task:
  [D][N] return book (by: Sunday 1pm)
Now you have 2 task(s) in the list.

Marking a task as done: done

Marks the specified task in Duke as done.

Format: done TASK_INDEX

• Marks the task at the specified TASK_INDEX as done.
• The TASK_INDEX refers to the task number shown in the displayed task list.
• The TASK_INDEX must be a positive integer greater than 0.

Example of usage: done 1

Expected outcome:
Nice! I've marked this task as done:
  [T][Y] read book

Finding tasks using a keyword: find

Finds all the tasks in Duke that contains the given keyword.

Format: find KEYWORD

• The search is case-sensitive. e.g. Book will not match book
• Both the task description and timing (if any) will be searched.
• The task number of the task shown corresponds to its task number in the full displayed task list.

Example of usage: find meeting

Expected outcome:
Here is(are) the 1 matching task(s) in your list:
  2.[E][N] meeting (at: 30/10/2020 1300-1400)

Clearing all tasks: clear

Clears all tasks from Duke.

Format: clear

Example of usage: clear

Expected outcome:
All previous data has been deleted...
The task list is now empty.

Exiting the program: bye

Exits Duke.

Format: bye

Example of usage: bye

Expected outcome:
Bye. Hope to see you again soon!

Saving the data

Duke data is automatically saved in the hard disk whenever any changes to the data is made. There is no need for manual saving. Previously saved data would also be loaded (if any) when Duke is booted up.

Command Summary

Command	Format, Examples
todo	todo DESCRIPTION e.g., todo buy bread
deadline	deadline DESCRIPTION by/ TIME_DEADLINE_IS_DUE e.g., deadline return book /by Sunday 1pm
event	event DESCRIPTION at/ EVENT_TIMING e.g., event meeting /at 30/10/2020 1300-1400
list	list
delete	delete TASK_INDEX e.g., delete 2
done	done TASK_INDEX e.g., done 1
find	find KEYWORD e.g., find meeting
clear	clear
bye	bye