https://github.com/kateryna-borysenko/contact-shelf-cli
CLI application for managing contacts
https://github.com/kateryna-borysenko/contact-shelf-cli
cli-app commanderjs expressjs nodejs nodemon
Last synced: 3 months ago
JSON representation
CLI application for managing contacts
- Host: GitHub
- URL: https://github.com/kateryna-borysenko/contact-shelf-cli
- Owner: Kateryna-Borysenko
- Created: 2024-02-12T16:34:44.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-12T18:34:09.000Z (over 2 years ago)
- Last Synced: 2025-06-13T20:39:44.072Z (about 1 year ago)
- Topics: cli-app, commanderjs, expressjs, nodejs, nodemon
- Language: JavaScript
- Homepage:
- Size: 261 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Contact Shelf CLI
## Description
Contact Shelf CLI is a command-line application for managing contacts. It allows users to perform basic CRUD operations (Create, Read, Update, Delete) on contacts stored in a JSON file.
## Installation
To run this project, you must have [Node.js](https://nodejs.org/) installed.
1. Clone the project repository:
```
git clone https://github.com/Kateryna-Borysenko/contact-shelf-cli.git
```
2. Navigate to the project directory:
```
cd contact-shelf-cli
```
3. Install the required dependencies:
```
npm install
```
## Usage
After installation, you can use the following commands to manage contacts:
- **List all contacts:**
`node index.js -a list`
- **Get a contact by ID:**
`node index.js -a get -i `
- **Add a new contact:**
`node index.js -a add -n -e -p `
- **Remove a contact by ID:**
`node index.js -a remove -i `
- **Update contact information:**
`node index.js -a update -i -n -e -p `
## License
[MIT](https://choosealicense.com/licenses/mit/)