Caviar User Guide

Introduction

Caviar, a type of fish roe. Speak to the fish in the water for your tasks!

Caviar is an interactive task manager with a personality—sometimes ending and starting sentences with roe.

Choose between CLI or GUI interaction with your task manager!

Features

• Tasks Management – Add, mark, unmark, list, and delete tasks.
• Deadline Tracker – Set deadlines with a due date and time.
• Event Scheduler – Schedule events with start and end dates and times.
• Find Tasks – Search for tasks by description.
• Sort Task List – Sort your list with different options (chronologically or in reverse order).
• Error Handler – Get warnings if commands are invalid.

---

Setup

1. Download the latest release, and run the application (e.g., java -jar Caviar.jar).
2. If you prefer the GUI, launch the jar file and interact normally with the chat window.
   For CLI usage, run the program in Caviar.java and type commands into your terminal.

---

Interactions

1. Adding a To-Do Task

Creates a simple task with no date/time.

Command:

todo <task description>

2. Adding a Deadline

Command:

deadline <task description> /by <YYYY-MM-DD HHmm>

Compulsory: description and datetime

3. Adding an Event

Command:

event <event description> /from <YYYY-MM-DD HHmm> /to <YYYY-MM-DD HHmm>

Compulsory: description, /from datetime, and /to datetime

4. View Task List

Command:

list

5. Find Tasks

Command:

find <keyword>

Compulsory: tasks contain keyword in their description.

6. Sort Tasks

Commands:

sort 1

sort 2

• Sort all tasks chronologically or reverse-chronologically

sort todo 1

• Sort only todo tasks chronologically

sort deadline 2

• Sort only deadline tasks reverse-chronologically

sort event 1

• Sort only event tasks chronologically

7. Mark Task as Done

Command:

mark <task number>

8. Unmark a Task

Command:

unmark <task number>

9. Delete Task

Command:

delete <task number>

Compulsory: Deleting tasks by indices.

11. Exiting Caviar

Command:

bye

Willing to contribute to this project? feel free to submit PRs!