Duke - User Guide
By Chen Su, 2019
1. Introduction
2. Quick Start
3. Features
3.1 Adding a task: todo/deadline/event
3.2 Lising task list: list
3.3 Marking task(s) as done: done
3.4 Deleting task(s): delete
3.5 Searching by keyword: find
4. Command Summary
1. Introduction
Duke is for those who prefer to use a desktop app for managing tasks. More importantly, Duke is optimized for those who prefer to work with a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, Duke can get your contact management tasks done faster than traditional GUI apps. Interested? Jump to the Section 2, “Quick Start” to get started. Enjoy!
2. Quick Start
- Ensure you have
Java 11
or above installed in your Computer. - Download the latest
duke.jar
here. - Copy the file to the folder you want to use as the home folder for your Duke.
- Double-click the file to start the app. The GUI should appear in a few seconds.
- Type your command at the bottom of the GUI and press
Enter
or clickSend
button at the right bottom to execute it. - Refer to Section 3, “Features” for details of each command.
3. Features
3.1 Adding a task
There are 3 types of tasks for you to better categorize your tasks.
(a) Add a todo task: todo
Adds a todo task into the task list.
Format: todo ACTIVITY_NAME
Example:
todo read newspaper
Adds a todo taskread newspaper
into the task list.
(b) Add a deadline task: deadline
Adds a deadline task that needs to be done by a particular time into the task list.
Format: deadline ACTIVITY_NAME / by TIME
Example:
deadline return book / by Sunday
Adds a deadline taskreturn book
that needs to be done by Sunday into the task list.
(c) Add an event task: event
Adds a deadline task that happens at a particular time into the task list.
Format: event ACTIVITY_NAME / at TIME
Example:
event midterm / at Oct 5
Adds a event taskmidterm
that happens on Oct 5 into the task list.
3.2 Listing task list: list
Shows the list of existing tasks in the task list.
Format: list
3.3 Marking task(s) as done: done
Marks task(s) with particular index as done.
Format: done INDEX
or done RANGE
or done INDEX...
Example:
done 1
Marks the 1st task in the list as done.
done 2-5
Marks the tasks with index 2, 3, 4, 5 as done.
done 3,5
Marks the task with index 3 and 5 as done.
3.4 Deleting tasks(s): delete
Deletes task(s) with particular index.
Format: delete INDEX
or delete RANGE
or delete INDEX...
Example:
delete 1
Deletes the 1st task in the list.
delete 2-5
Deletes the tasks with index 2, 3, 4, 5.
delete 3,5
Deletes the task with index 3 and 5.
3.5 Searching by keyword: find
Searches the tasks according to the keywords.
Format: find KEYWORD
Example:
find todo
Gives result(s) of all tasks that contains “todo” in their descriptions.
find read book
Gives result(s) of all tasks that contains “read book” in their descriptions.
4. Command Summary
Command | Format |
---|---|
Add | todo ACTIVITY_NAME deadline ACTIVITY_NAME / by TIME event ACTIVITY_NAME / at TIME |
List | list |
Done | done INDEX or done RANGE or done INDEX... |
Delete | delete INDEX or delete RANGE or delete INDEX... |
Search | find KEYWORD |
Feedback, Bug Reports
- If you have feedback or bug reports, please post in chensu2436/duke issue tracker.
- Pull requests are welcomed too.