Dictionary-CLI

A command line tool built to feature dictionary functionality. The tool is built using nodejs with modules : 'commanderjs' and 'inquirerjs'. It consumes data from dictionary server, which is hosted on heroku, using REST APIs.

Installation/Setting up :-

Step 0) You need to have Nodejs, npm installed in your system.
Step 1) Clone the directory.
Step 2) Navigate to the folder in terminal.
Step 3) Type the command 'npm link' so as to make the commands work on your command prompt.
Use the commands and experience the small-dictionary API.

Usage :-

There are mainly 7 commands that implement dictionary functionalities:

0. GET HELP (the most important)

command : dict help

1. Get definitions of the word :
   command : dict defn <your_word> (OR) dict definition <your_word>.

2. Get synonyms of the word :
   command : dict syn <your_word> (OR) dict synonym <your_word>.

3. Get antonyms of the word :
   command : dict ant <your_word> (OR) dict antonym <your_word>.
   If antonym doesn't exist, a message is shown stating that the given word doesn't contain any antonyms.

4. Get examples of usage for the word :
   command : dict ex <your_word> (OR) dict example <your_word>.
   It displays some example sentences of how the word can be used.

5. Get a random word and its information :
   command : dict
   It shows a random word and all its information : definitions, synonyms, antonyms and examples.

6. Get all information related to a word :
   command : dict <your_word>
   It shows whole information (definitions, synonyms, antonyms and examples) of the word.

7. Play a Guess game :
   command : dict play game
   Play the game according to the given rules.

Rules :

• If the correct word is entered, show success message
• Any synonyms of the word(expected answer) should be also be accepted as a correct answer.
• If incorrect word is entered, user has 3 choices:
  • (1) Try again user tries again.
  • (2) Hint Hints could be: 1. Display the word randomly jumbled (cat => atc, tac, tca) 2. Display another definition of the word 3. Display another antonym of the word 4. Display another synonym of the word After taking hints, user guesses again.
  • (3) Quit Displays the Word, Word Full Dict , and quit.