Jarvis User Guide
βSimplicity is the ultimate sophistication.β - Leonardo da Vinci (source)
Experience organization and productivity like never before with Jarvis β your ultimate task manager. Simplify your life, one task at a time.
Installation
- Download the latest
.jarfile from here. - Navigate to the directory of installation, and open Terminal.
- Run
java -jar jarvis.jarand enjoy the luxury of having your own manager!
Features
- Allows various types of tasks (Events, Deadlines, Todo)
- Stores and retrieves data directly to/from a designated .txt file
- Enables marking/unmarking of tasks on completion
- Grants users the ability to search for their respective task
- Reminders users on overdue and upcoming events and deadlines.
Special Attributes
- Easy to learn
- Available 24/7 at your service
- Created by
ShishirTony Stark himself - Free of charge
Usage
βImportant:
- Words in UPPER_CASE are the parameters to be supplied by the user. e.g. in
todo TASKNAME,TASKNAMEis a parameter which can be used astodo Buy iPad.- The parameters can contain whitespaces (e.g.
Buy iPad), and must be seperated from the command and the type specifiers (/by,/from,/to) by atleast 1 whitespace character from both sides. e.g.todoTASKNAMEanddeadline TASKNAME/byDATEare invalid, butdeadline TASKNAME /by DATEis valid.- Input date for tasks like
eventanddeadlinemust follow the formatDD/MM/YY HHMMwithHHMMfollowing the 24 hours format. e.g.23/09/23 1800.- Parameters have to be in the specified order, otherwise it will result in an invalid message. e.g. if the command specifies
TASKNAME /by DEADLINE,/by DEADLINE TASKNAMEis invalid.- Extraneous parameters for commands that do not take in parameters (such as
list,byeandremind) will result in an invalid message.- If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application.
Listing all tasks: list
Shows a list of all the tasks (event, deadline, and todo) in the task list.
Format: list
Example of usage: list
Expected output:
Tasks displayed. Your guidance is requested.
1. π β Play Basketball
Adding a task with no time constraints: todo
Adds a todo task into the list.
Format: todo TASKNAME
Example of usage: todo Play Basketball
Expected output:
Added the following task to the list.
1. π β Play Basketball
You currently have 1 tasks in your list.
Adding a task with a deadline: deadline
Adds a deadline task into the list.
Format: deadline TASKNAME /by DEADLINE
Example of usage: deadline Complete CS2100 Assignment /by 18/09/23 1315
Expected output:
Added the following task to the list.
2. β° β Complete CS2100 Assignment (by: Sep 18 2023 01:15 pm)
You currently have 2 tasks in your list.
Adding a task with a starting and ending time: event
Adds a event task into the list.
Format: event TASKNAME /from FROM /to TO
Example of usage: event CS2103T Final Exam /from 01/12/23 0900 /to 01/12/23 1030
Expected output:
Added the following task to the list.
3. ποΈ β CS2103T Final Exam (from: Dec 1 2023 09:00 am to: Dec 1 2023 10:30 am)
You currently have 3 tasks in your list.
Removing a task: delete
Removes the task matching the given index.
Format: delete INDEX
Example of usage: delete 3
Expected output:
The following task has been removed.
3. ποΈ β CS2103T Final Exam (from: Dec 1 2023 09:00 am to: Dec 1 2023 10:30 am)
Is there anything else I can assist you with?
Completing a task: mark
Marks the task matching the given index as complete.
Format: mark INDEX
Example of usage: mark 1
Expected output:
The following task is marked as complete:
1. ποΈ β Play Basketball
Is there anything else I can assist you with?
Removing completion of a task: unmark
Marks the task matching the given index as incomplete.
Format: unmark INDEX
Example of usage: unmark 1
Expected output:
The following task has been umarked:
1. ποΈ β Play Basketball
Is there anything else I can assist you with?
Search for a task: find
Finds a list of tasks containing the given keyword.
Format: find KEYWORD
Example of usage: find Basketball
Expected output:
The following tasks match the entered keyword:
1. ποΈ β Play Basketball
Generating a reminder: remind
Creates a reminder containing pending and passed event and deadline tasks.
It is also automatically called at the start of execution.
Format: remind
Example of usage: remind
Expected output:
Just a friendly reminder, the following tasks are pending completion!
1. β° β Complete CS2100 Assignment (by: Sept 18 2023 01:15 pm)
Exit the application: bye
Exits from the application. An alternate way of exit is by pressing the close button (located at the top right corner of your screen).
Format: bye
Example of usage: bye
Expected output:
I shall now take my leave. Farewell!
Command Summary
| Action | Format | Examples |
|---|---|---|
| Add Todo Task | todo TASKNAME |
todo Play Basketball |
| Add Deadline Task | deadline TASKNAME /by DEADLINE |
deadline Complete CS2100 Assignment /by 18/09/23 1315 |
| Add Event Task | event TASKNAME /from FROM /to TO |
event CS2103T Final Exam /from 01/12/23 0900 /to 01/12/23 1030 |
| List | list |
list |
| Delete | delete INDEX |
delete 3 |
| Mark | mark INDEX |
mark 1 |
| Unmark | unmark INDEX |
unmark 1 |
| Find | find KEYWORD |
find Basketball |
| Remind | remind |
remind |
| Exit | bye |
bye |