Skip to content

Latest commit

 

History

History
84 lines (56 loc) · 1.58 KB

README.md

File metadata and controls

84 lines (56 loc) · 1.58 KB

Notes APP[CLI]

These app is used for creating, reading and removing Notes entered by the user, added colorful text using Chalk.

Getting Started

npm install

This will install all the dependencies for the project

node app.js --help

This will help you to get started and use the CLI for Notes.

Prerequisites

What things you need to install the software and how to install them

yargs.command({
  command: "your command",
  describe: "command description",
  builder: {
      title:{
          describe: "parameter description",
          demandOption: true, // required as true
          type: "string" //type of parameter you recieved
      }
  },
  handler: ({ title }) => {
      Notes.readNotes(title); // handle the methods
  }
});

Example

Adding Notes
node app.js add --title="titlename" --body="body detail"
Removing Notes
node app.js remove --title="titlename"
Listing Notes
node app.js list
Reading Notes
node app.js read --title="titlename"

Built With

  • Yargs - Yargs be a node.js library fer hearties tryin' ter parse optstrings
  • Chalk - Terminal string styling done right

Contributing

Please read for details on our code of conduct, and the process for submitting pull requests to us.

Authors

  • Aditya Vyas

See also the list of contributors who participated in this project.

License

This project is licensed under the ISC License