Welcome to the Python CLI Assistant! This command-line program helps you manage your contact book, notes, and more with simple and intuitive commands.
Photo by Izabel
- Add and manage contacts with various details like name, phone, email, and birthday.
- Create and manage notes with tags for better organization.
- Easily search for and manipulate contact and note records.
- View and manage notes, tags, and contact details in a browsing mode.
To get started, clone this repository and follow the installation instructions in the Installation section.
| Command Syntax | Description |
|---|---|
| hello | Show a friendly greeting. |
| help | Display a help message with available commands. |
| add {name} | Add a new contact record. |
| add {name} {data} | Add details like birthday, phone, or email. |
| change {name} {data} | Change contact data. |
| delete {name} | Delete a contact record. |
| delete {name} {data} | Delete specific data from a contact. |
| search {name} | Search for contact record(s). |
| show all | Show all contact records in a browsing mode. |
| show page {page_#} | Go to page # of the adress book. |
| show phones {name} | List phones associated with a contact. |
| show emails {name} | List emails associated with a contact. |
| show birthday {name} | Show birthday of a contact. |
| birthdays in {#_of_days} | Display all birthdays in the next # of days. |
| note | Enter the note taking mode |
| show all | (in the note taking mode) Show all notes and their tags in browsing mode. |
| add note {name} {tags} | (in the note taking mode) Add a new note. |
| delete note {name} | (in the note taking mode) Delete an existing note. |
| edit note {name} | (in the note taking mode) Edit an existing note in a text editor. |
| edit tags {name} | (in the note taking mode) Edit tags via cli interface. |
| search name {name} | (in the note taking mode) Search for notes by name. |
| search tags {name} | (in the note taking mode) Search for notes by tag. |
For more details and examples, please refer to the documentation.
- Clone the repository:
git clone https://github.com/your-username/python-cli-assistant.git
cd python-cli-assistant- Install dependancies:
pip install -r requirements.txt- Run the Python CLI Assistant:
python assistant.pyThis project is licensed under the MIT License.