amans-joke-tool v1.0.2

Welcome to Dad Jokes CLI Tool!

Hello, this is a simple CLI tool to tell you dad jokes, have fun using it!

Tech Used

• Node Js

Installation

Install amans-joke-tool with npm

  cd my-project
  npm i amans-joke-tool

Run Locally

Clone the project

  git clone https://github.com/Aman-Gupta-404/jokes_cli_tool

Go to the project directory

  cd my-project

Install dependencies

  npm install

Install the CLI Command line tool locally

  npm install -g

Usage/Examples

Get a random joke using the command

  amans-joke-tool

Get a joke containing a specific keyword by passing the keyword as a paramater Please note that the keyword should be of one word only

  amans-joke-tool --keyword

  //example
  amans-joke-tool --building

Check the leaderboard for the jokes that appeared the most using the command below

  amans-joke-tool --leaderboard

Note: while using the tool, 2 new files are created who's names and purpose is given below 1. All_jokes.txt - Stores all the jokes generated 2. popularJokes.txt - Stores the leaderboard scores for all the jokes

Authors

• @Aman-Gupta-404