AddressBook Level 3 (AB3) is a desktop app for managing contacts, optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB3 can get your contact management tasks done faster than traditional GUI apps.
- Quick start
- Known issues
- Command summary
Ensure you have Java
11or above installed in your Computer.
Download the latest
Copy the file to the folder you want to use as the home folder for your AddressBook.
Open a command terminal,
cdinto the folder you put the jar file in, and use the
java -jar addressbook.jarcommand to run the application.
A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
Type the command in the command box and press Enter to execute it. e.g. typing
helpand pressing Enter will open the help window.
Some example commands you can try:
list: Lists all contacts.
add n/John Doe p/98765432 email@example.com a/John street, block 123, #01-01: Adds a contact named
John Doeto the Address Book.
delete 3: Deletes the 3rd contact shown in the current list.
clear: Deletes all contacts.
exit: Exits the app.
Refer to the Features below for details of each command.
Notes about the command format:
UPPER_CASEare the parameters to be supplied by the user.
NAMEis a parameter which can be used as
add n/John Doe.
Items in square brackets are optional.
n/NAME [t/TAG]can be used as
n/John Doe t/friendor as
… after them can be used multiple times including zero times.
[t/TAG]…can be used as
Parameters can be in any order.
e.g. if the command specifies
p/PHONE_NUMBER n/NAMEis also acceptable.
Extraneous parameters for commands that do not take in parameters (such as
clear) will be ignored.
e.g. if the command specifies
help 123, it will be interpreted as
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.
Viewing help :
Shows a message explaning how to access the help page.
Adding a person:
Adds a person to the address book.
add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…
add n/John Doe p/98765432 firstname.lastname@example.org a/John street, block 123, #01-01
add n/Betsy Crowe t/friend email@example.com a/Newgate Prison p/1234567 t/criminal
Listing all persons :
Shows a list of all persons in the address book.
Editing a person :
Edits an existing person in the address book.
edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…
- Edits the person at the specified
INDEX. The index refers to the index number shown in the displayed person list. The index must be a positive integer 1, 2, 3, …
- At least one of the optional fields must be provided.
- Existing values will be updated to the input values.
- When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative.
- You can remove all the person’s tags by typing
t/without specifying any tags after it.
edit 1 p/91234567 firstname.lastname@example.orgEdits the phone number and email address of the 1st person to be
edit 2 n/Betsy Crower t/Edits the name of the 2nd person to be
Betsy Crowerand clears all existing tags.
Locating persons by name:
Finds persons whose names contain any of the given keywords.
find KEYWORD [MORE_KEYWORDS]
- The search is case-insensitive. e.g
- The order of the keywords does not matter. e.g.
Hans Bowill match
- Only the name is searched.
- Only full words will be matched e.g.
Hanwill not match
- Persons matching at least one keyword will be returned (i.e.
Hans Bowill return
find alex davidreturns
Deleting a person :
Deletes the specified person from the address book.
- Deletes the person at the specified
- The index refers to the index number shown in the displayed person list.
- The index must be a positive integer 1, 2, 3, …
delete 2deletes the 2nd person in the address book.
find Betsyfollowed by
delete 1deletes the 1st person in the results of the
Clearing all entries :
Clears all entries from the address book.
Exiting the program :
Exits the program.
Saving the data
AddressBook data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.
Editing the data file
AddressBook data are saved automatically as a JSON file
[JAR file location]/data/addressbook.json. Advanced users are welcome to update data directly by editing that data file.
Archiving data files
[coming in v2.0]
Details coming soon …
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 file that contains the data of your previous AddressBook home folder.
When using multiple screens, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the
preferences.jsonfile created by the application before running the application again.