Alexis User Guide

Alexis is a desktop app for managing a user’s tasks, optimized for use via a Command Line Interface (CLI). The clean interface helps the user to be focused and productive.

• Quick start
• Features
• Create a New Task:
• todo
• deadline
• event
• Display Your Tasks list
• Mark Your Tasks as Completed:
• mark
• unmark
• Delete an Existing Task delete
• Search for all Tasks Occurring on a Date show
• Search for a Task easily find
• Automatic Saving of Task Data to Local Storage
• FAQ
• Command Summary

---

Quick start

1. Click on the latest release of this application and download the `ip.jar` file.


2. Locate the `ip.jar` file in your directory.
   


3. Right-click and open up your terminal.
   
   The terminal will pop-up. Do double-check that you are in the same folder as the downloaded ip.jar file.
   
   Alternatively, open your command prompt and navigate to the folder containing the ip.jar file.



4. Type in java -jar ip.jar and hit Enter.
   You should be able to see this if you have followed the steps correctly:
   

   
      Hello! I'm Alexis, your trusty helper!
            __      ___       _______  ___  ___   __      ________
           /""\    |"  |     /"     "||"  \/"  | |" \    /"       ) 
          /    \   ||  |    (: ______) \   \  /  ||  |  (:   \___/ 
         /' /\  \  |:  |     \/    |    \\  \/   |:  |   \___  \
        //  __'  \ \\  |___  // ___)_   /\.  \   |.  |    __/  \\ 
       /   /  \\  \( \_|:  \(:      "| /  \   \  /\  |\  /" \   :) 
      (___/    \___)\_______)\_______)|___/\\__|(__\_|_)(_______/
      



5. Enjoy!! :D

---

Features

Notes about the command format:

• Words in UPPER_CASE are the parameters to be supplied by the user. e.g. in todo TASK, TASK is a parameter which can be used as todo return book.
• Expected format of inputted date is dd/MM/yyyy. e.g. 28/02/2022

1. Create a New Task

Create a new task that is a deadline, an event, or a to-do, and add it to Alexis’s list for him to keep track of your tasks.

• Adding a Todo Task: todo

Format: todo TASK

Example of usage: todo return book
Expected outcome: New todo task is created


---------------------------------------------------------------
Got it! I've added this task:
  [T][ ] return book
---------------------------------------------------------------




• Adding a Deadline Task: deadline

Format: deadline TASK /by DATE
Note: expected format of DATE is dd/MM/yyyy

Example of usage: deadline finish assignment /by 28/02/2022
Expected outcome: New deadline task is created


---------------------------------------------------------------
Got it! I've added this task:
  [D][ ] finish assignment (by: Feb 28 2022)
---------------------------------------------------------------




• Adding an Event Task: event

Format: event TASK /at DATE
Note: expected format of DATE is dd/MM/yyyy

Example of usage: event lecture /at 01/03/2022
Expected outcome: New event task is created


---------------------------------------------------------------
Got it! I've added this task:
  [E][ ] lecture (at: Mar 01 2022)
---------------------------------------------------------------

2. Display Your Tasks: list

• Get Alexis to display all the tasks that you have created and given to him to keep track on.

Format: list

Example of usage: list
Expected outcome: Task list is displayed


---------------------------------------------------------------
Here are the tasks in your list:
1.[T][ ] return book
2.[D][ ] finish assignment (by: Feb 28 2022)
3.[E][ ] lecture (at: Mar 1 2022)
---------------------------------------------------------------

3. Mark Your Tasks as Completed

Tell Alexis that you have completed a task, and he will update it accordingly in his list of tasks.

• Mark a task: mark

Format: mark TASK_NUMBER

Example of usage: mark 1
Expected outcome: Task number 1 is marked


---------------------------------------------------------------
Great! I've marked this task as done:
  [T][X] return book
---------------------------------------------------------------




• Unmark a task: unmark

Format: unmark TASK_NUMBER

Example of usage: unmark 1
Expected outcome: Task number 1 is unmarked


---------------------------------------------------------------
Ok. I've marked this task as not done yet:
  [T][ ] return book
---------------------------------------------------------------

4. Delete an Existing Task: delete

• Removes a task.

Format: delete TASK_NUMBER

Example of usage: delete 1
Expected outcome: Task number 1 is deleted


---------------------------------------------------------------
Noted. I've removed this task:
  [T][ ] return book
Now, you have 2 tasks in the list.
---------------------------------------------------------------

5. Search for all Tasks Occurring on a Date: show

• Enter a valid date and Alexis will show you the deadlines/events that lie on that date.

Format: show DATE
Note: expected format of DATE is dd/MM/yyyy

Example of usage: show 01/03/2022
Expected outcome: Deadlines/events on 01/03/2022 are displayed


---------------------------------------------------------------
Here are the events/deadlines on Mar 1 2022:
1.[E][ ] lecture (at: Mar 1 2022)
---------------------------------------------------------------

Example of usage: show 02/03/2022
Expected outcome: No deadlines/events fall on the specified date


---------------------------------------------------------------
There are no events/deadlines on Mar 2 2022
---------------------------------------------------------------

6. Search for a Task easily: find

• Enter a search query and Alexis will show you the tasks that matches your search keywords.

Format: find KEYWORD

Example of usage: find assignment
Expected outcome: Displays tasks which contain "assignment" in their description


---------------------------------------------------------------
Here are the matching tasks in your list:
1.[D][ ] finish assignment (by: Feb 28 2022)
---------------------------------------------------------------

Example of usage: find exam
Expected outcome: There are no tasks that contain "exam" in their description


---------------------------------------------------------------
There are no matching tasks in your list
---------------------------------------------------------------

7. Exiting the Program: bye

Format: bye

Example of usage: bye
Expected outcome: Exits the program


---------------------------------------------------------------
Bye. Hope to see you again soon!
---------------------------------------------------------------

8. Automatic Saving of Task Data to Local Storage

• Every time you create, update, or delete a task, Alexis automatically saves these changes into a file that is stored locally on your system’s storage. This way, your tasks will remain after you exit Alexis for the day and will be available the next time you start him up.
• The data is stored in the ./data/tasks.txt file relative to the location of the ip.jar file.
  
  

---

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 data in the previous ./data/task.txt file

More questions will be added when I gather more feedback upon releasing v1.0 of Alexis.

---

Command Summary

Action	Format, Examples
todo	todo TASK e.g., todo read
deadline	deadline TASK /by DATE e.g., deadline return book /by 28/02/2022
event	event TASK /at DATE e.g., event career fair /at 01/03/2022
mark	mark TASK_NUMBER e.g., mark 2
unmark	unmark TASK_NUMBER e.g., unmark 5
list	list
delete	delate TASK_NUMBER e.g., delete 1
show	show DATE e.g., show 08/05/2022
find	find KEYWORD e.g., find book
bye	bye

Go back to top