Chatbot Apple is an app to manage tasks, optimised for use through a Command Line Interface (CLI).
- Ensure Java 11 or above is installed in your computer
- Download
ip.jarfrom here - Open a command terminal,
cdinto the folder with the jar file and use thejava -jar ip.jarcommand to run the application.
A CLI similar to the picture below should appear in a few seconds. Note how the app returns the path to which the list of tasks is saved on the local computer.
- Type the command into the command line and press Enter to execute it. e.g. typing list and pressing Enter will list the current tasks. Some example commands you can try:
todo tutorial: Adds task "tutorial" to the listdeadline return book by 4pm: Adds task "return book" nd deadline "4pm" to the listlist: Lists all tasksbye: Exits the app
- Refer to the Features below for more details on each command.
[!NOTE]
Words in
UPPER_CASEare parameters to be supplied by the user. e.g. indelete INDEX,INDEXis a parameter which can be used asdelete 3
Lists all tasks in the task list.
Format: list
Adds task of type todo to the list of tasks
Format: todo DESCRIPTION
Examples:
todo tutorialAdds tasktutorialto the list of taskstodo watch lectureAdds taskwatch lectureto the list of tasks
ADD PIC HERE
Adds task of type deadline to the list of tasks
Format: deadline DESCRIPTION by DEADLINE
Examples:
deadline return book by 4pmAdds taskreturn bookwith deadline4pmto the list of tasksdeadline submit report by 7pmAdds tasksubmit reportwith deadline7pmto the list of tasks
ADD PIC HERE
Adds task of type event to the list of tasks
Format: event DESCRIPTION from START to END
Examples:
event Math exam from 2pm to 4pmAdds taskMath examwith timeline2pmto4pmto the list of tasksevent project group meeting from 11am to 1pmAdds taskproject group meetingwith timeline11amto1pmto the list of tasks
ADD PIC HERE
Deletes task from the list of tasks
Format: delete INDEX
- Deletes task at the specified
INDEX. - The index refers to the index of the task in the list of tasks.
- The index must be a positive integer.
Examples:
delete 3Deletes third task in the listdelete 5Deletes fifth task in the list
Marks tasks as completed
Format: mark INDEX
- Marks task as done at the specified
INDEX. - The index refers to the index of the task in the list of tasks.
- The index must be a positive integer.
Examples:
mark 1Marks first task in the list as donemark 6Marks sixth task in the list as done
Marks tasks as undone
Format: unmark INDEX
- Marks task as not done at the specified
INDEX. - The index refers to the index of the task in the list of tasks.
- The index must be a positive integer.
Examples:
unmark 1Marks first task in the list as notdoneunmark 2Marks second task in the list as not done
Filters list of tasks to those containing the keyword the user wants to find
Format: find KEYWORD
Examples:
find bookCLI returns a list with all the tasks with theKEYWORDbook.find tutorialCLI returns a list with all the tasks with theKEYWORDtutorial.
Exits the chatbot
Format: bye
| Command | Format, Examples |
|---|---|
list |
list |
todo |
todo DESCRIPTION e.g. todo tutorial |
deadline |
deadline DESCRIPTION by DEADLINE e.g. deadline return book by 4pm |
event |
event DESCRIPTION from START to END e.g. event Math exam from 2pm to 4pm |
delete |
delete INDEX e.g. delete 3 |
mark |
mark INDEX e.g. mark 2 |
unmark |
unmark INDEX e.g. unmark 1 |
find |
find KEYWORD e.g. find book |
bye |
bye |