Skip to content

Latest commit

 

History

History
 
 

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 

User Guide

Duke is a desktop app for managing tasks, optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). Duke provides flexibility by allowing the tracking of various types of tasks including events and deadlines.

Quick Start

  1. Ensure you have Java 11 or above installed in your Computer.
  2. Download the latest Duke.jar file from here.
  3. Copy the file to the folder you want to use as the home folder for your Duke program.
  4. Double-click the file to start the app. The GUI similar to the below should appear in a few seconds.

Duke UI display

  1. Type the command in the command box and press Send to execute it. Some examples you can try:
  • list: Lists all tasks.
  • todo return book: Adds a todo for returning book
  1. Refer to the Features below for details of each command.

Features

Task management

Add tasks by indicating type of task to add or delete tasks by indicating index of task to delete.

Track task status

Mark or unmark task to track completed and incomplete tasks.

View tasks

Display all tasks in a list or filter tasks using a keyword.

Usage

Adding a task

You can add either a todo, event (occurs on a specified date) or deadline (due by a specified date) as tasks.

Adding a todo: todo

Adds a todo.

Format: todo TASK_DESCRIPTION

Examples:

  • todo CS2103T tutorial
  • todo watch movie

Expected outcome:

Todo added to task list when valid description given.

Got it. I've added this task:
[T][ ] TASK_DESCRIPTION
Now you have X tasks in the list.

Adding a deadline: deadline

Adds a deadline.

Format: deadline TASK_DESCRIPTION /by YYYY-MM-DD

Examples:

  • deadline return book /by 2022-09-20
  • deadline submit CS2102 assignment /by 2022-09-17

Expected outcome:

Deadline added to task list when valid description and date given.

Got it. I've added this task:
[D][ ] TASK_DESCRIPTION (by: MMM DD YYYY)
Now you have X tasks in the list.

Adding an event: event

Adds an event.

Format: event TASK_DESCRIPTION /at YYYY-MM-DD

Examples:

  • event NUS internship day /at 2022-10-30
  • event NUS Supernova /at 2022-09-22

Expected outcome:

Event added to task list when valid description and date given.

Got it. I've added this task:
[E][ ] TASK_DESCRIPTION (at: MMM DD YYYY)
Now you have X tasks in the list.

Listing all tasks: list

Displays a list of tasks added.

Format: list

Expected outcome:

Here are the tasks in your list:
1. ...
2. ...

Deleting a task: delete

Deletes the task from task list.

Format: delete INDEX

  • Deletes the task at the specified INDEX.
  • INDEX refers to the index number shown after using list.

Examples:

  • delete 1 deletes the 1st task in list if it exists.

Expected outcome:

Deletes a task when valid index is given.

Noted. I've removed this task:
[X][ ] TASK_DESCRIPTION
Now you have X tasks in the list.

Finding specific tasks: find

Display tasks where the description matches given keywords.

Format: find KEYWORD

  • Search is case-sensitive. e.g. homework will not match with Homework
  • Partial keywords can be used as well. e.g. work will match with homework

Examples:

  • find homework returns a list of all tasks with description containing the keyword homework
  • find NUS concert returns a list of all tasks with description containing the keyword NUS concert

Expected outcome:

Here are the matching tasks in your list:
1. ...
2. ...

Marking a task: mark

Marks a task as completed.

Format: mark INDEX

  • Marks the task at the specified INDEX as completed.
  • INDEX refers to the index number shown after using list.

Examples:

  • mark 1 marks the first task in list if it exists.

Expected outcome:

Marks a task as completed when valid index is given.

Nice! I've marked this task as done:
[X][X] TASK_DESCRIPTION

Unmarking a task: unmark

Marks a task as incomplete.

Format: unmark INDEX

  • Marks the task at the specified INDEX as incomplete.
  • INDEX refers to the index number shown after using list.

Examples:

  • unmark 1 marks the first task in list as incomplete if it exists.

Expected outcome:

Marks a task as incomplete when valid index is given.

OK, I've marked this task as not done yet:
[X][ ] TASK_DESCRIPTION

Exiting the program: bye

Exits the program.

Format: bye

Expected outcome:

Prints goodbye message and exits the program.

Bye. Hope to see you again soon!

FAQ

Q: How do I transfer my data to another Computer?

A: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous Duke home folder.

Command summary

Action Format, Examples
todo todo TASK_DESCRIPTION
e.g. todo watch movie
deadline deadline TASK_DESCRIPTION /by YYYY-MM-DD
e.g. deadline CS2101 Assignment /by 2022-09-15
event event TASK_DESCRIPTION /at YYYY-MM-DD
e.g. event NUS Supernova /at 2022-09-01
list list
delete delete INDEX
e.g. delete 1
find find KEYWORD
e.g. find test
mark mark INDEX
e.g. mark 3
unmark unmark INDEX
e.g. unmark 2
bye bye