Skip to content

tanmaysuryawanshi/cli-notesapp-nodejs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Notes App CLI 📒

Overview

This CLI-based notes app allows users to manage their notes efficiently using various commands. It's built with Node.js and uses Yargs for command-line argument parsing, and Chalk for colorful console outputs.

Commands

add <note>

Create a new note.

Usage:

note add "Your note content here" --tags "tag1,tag2" 

Options:

  • note: The content of the note you want to create.
  • --tags or -t: (Optional) Comma-separated tags to add to the note.

Example:

note add "Buy groceries" --tags "shopping,chores"

all

Retrieve all notes.

Usage:

note all

find <filter>

Get notes matching the given filter.

Usage:

note find <filter>

remove <id>

Remove a note by its ID.

Usage:

note remove <id>

clean

Remove all notes.

Usage:

note clean

Installation

  1. Clone the repository.
   git clone https://github.com/tanmaysuryawanshi/cli-notesapp-nodejs.git
  1. Navigate to the project directory
   cd cli-notesapp-nodejs
  1. Navigate to the project directory
   npm install
  1. create a link using npm
   npm link

Testing

The app is tested using Jest. To run tests, use:

npm test

About

A cli based notes app in nodejs

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published