Create a Command Line Interface (CLI) Using Node JS #01

help you guys out all the were doing welcome to new video tutorial from my Pinterest in today's one we're gonna talk about we're gonna just make a command-line interface or no js' and using of course JavaScript so we're just gonna go step by step on the like a process of making a command-line interface and probably explain with the command-line interface and just making it so since no J's very powerful jobs chris is very powerful and npm has a lot of pocket packages that gonna help us achieving the best performance in the best style out there so yeah we can do that very very easily in no jsn in most cases you're gonna need like command-line interface if for like for a lot of things to do rather than just going ahead and creating a graphical user interface you just use the command line and it can do the job for you like exactly the same so and more efficiently because you're not gonna focus on the graphics so I just recommend sites not talking about any idea of things let's just dive right into this so before this or before I'm sorry you're gonna need a couple of packages from no yes again so if you're not familiar with no GS if you're beginner to nowadays I have a full crew series on my channel so just go ahead and check it out watch the series it's very self-explanatory so you can understand what we are actually going to do on what we are actually doing on this particular tutorial so before as I've said we need some couple packages some of them are optional some of them are like necessary for the first sake of this tutorial so this videos or fig lets or whatever you gonna call it so this just gonna allow you to convert like a text like hello world into an ASP or ASCII tasks discuss can see in here made using characters like just beautiful application so if you're familiar with command-line interfaces it uses this this like this this one or make your application looks a bit better so you can just use it installment as we all think and this is very necessary using commander Diaz and this camera is gonna allow us just to parse the the arguments start gonna pass into our program and just parse and do some options and submit some like options on commands and stuff you're just gonna talk about briefly on this the other thing is inquires so inquire all those are linked on the description below so just go ahead and check them out or just go ahead and just check enquirer check commander jeaious and yeah we're just gonna talk or fig let's oh there and as I've said inquire is just gonna allow you to inquire or ask some questions so you can scroll all the way down it's just gonna give you this really really nice user interface over there or down here and it just gonna let you like gives you a list to select from I don't know all those checkboxes input fields so it just make your make you or interacts with the user a little bit more easier and more gives your application more flexibility and stuff like this so yeah it's gonna be very easy to use the inquire and mixer up actually looks a bit better the last thing we're gonna just cover is the chalk and this is one of the optional so you not needed that much but this will help you to color your or your your your text for printing on the command line so if you want to beautify your text and printing using colors whatever colors out there even with the background colors magenta I don't know sighing colors or whatever so you can use the chocolate burritos install it and you are ready to go so all of those are just in there yeah you are good to go after installing this so just go ahead and correct creating your project you can see I've already done a couple of things in here in this project for just the sake of time I'll go sell myself on this so I will explain why other than this but before this you need to install the things they have I was talking about actually in the packages there was naming a couple of seconds ago so just go ahead make sure to let me just close this run a new one and make sure to use NPM and make sure no J's is installing ugly or in your machine and just run npm install i need to install chalk as i've said commander which is necessary for good and inquire water on our king-type and mangoes mangoes I haven't talked about it because every like done and done I've done a tutorial on that so it is a MongoDB database a wrapper so which allows you to connect into a MongoDB or an actual database so you can fetch and save data into which in this case we're gonna use MongoDB to store our data which is going to be the contact so we're just gonna work on a contacts application sort of down and fit to the other prompt so you can see we have some among girls to make sure to install it so if you're not familiar with that really the last video tutorial I've spoken about and going step by step on mongos and MongoDB and explaining everything so make sure to check it out if you really want to understand what we're actually doing on this particular sorry so we have to enough talk after installing of that just setting up some nodejs to make sure you know how what are you doing you are good to go I'm just dive into the main projects I've named this mentor just because this our the core or the main thing or look from where our application is going to be right so let me just minimize this so you can see bit better now here we have imported the program the program is just comes from the commander the inquire from the inquire the fig let's from the piglets and the char from the chunk so it just makes sure to acquire all of those also we require mangoes I'm not just going to explain the mangoes thing because I already done this as I've said so just what is its derivative stories and you were briefly understand what we are doing in here so among girls and just gone crazy is a new schema or import of the schema and here I've done event imager why I've done the events emitter so one unlike connection to the database I will submit a special events called connected someone will know that we are connected to the base and we are ready to fetch or save or whatever like interacts with the database like respectively without without errors or without problems nothing at all so we are connected and we are good to go so here we're connected to the database MongoDB local house earlier name in our collection contact length this collection takes as a table so name contact legs and we're just checking for errors and here amazing of course this event connected event simple as that here the schema what we have is the first name last name number and agenda and by the way we here we are making a contactless application so what what's actually this application going to do is a contact manager so I just I don't know type your name or vacation and type the command block for example at contact and here you specify your contact details like the first name last name and yatta phone number press enter and it's going to audit this for you into the database or you can fetch this unlike specific contact on database stuff like this yeah can happen like this so here we're just greeting the skimmers upset first name the last name the number of the gender we are going to go and here we have the contacts which are just compiled in our schema into the model or MongoDB model so here we're good to go using contacts for this I have just a little like I don't know tiny array of objects the holds our information I've created this arbitrary phone numbers arbitrary names in here so make sure to use yours whatever I'm just gonna create this and they need to go ahead and take this into the MongoDB so so if you're not familiar with a MongoDB campus thing you're just gonna allow you or give you a graphical user interface that you can mean your place your databases and art and let's just manage them here I'm gonna just call this contact list and also contact list and let me just name the database contact so create a database and go into the database this collection and yeah we're just gonna insert a new documents we give it all of this information in here so because you can give me a second doing this now after inserting to the database manually of course you can do this automatically by just creating a script again it does this but it's just fine here just creating you name number and since our schema does have a first name last name and number and gender or mass or database doesn't have kind of things so what I'm going to do is just go get rid of that just for the sake of destroyer make it as simple as as possible to you for you to understand what we should be doing so let me just provide this name and just give it time string and we are going to give it the required trip so required isn't one once and yeah we are good to go over here now after requiring all of the needed ops over here so what we can do is just use the commander so we'll name the commander or after aquinas web name into the program and this like the main thing or this is the main program or the main parse or so we're gonna give it or feed it in our arguments I'm gonna pass him from the arguments V so all we doing here so just scroll all the way down as I've said we have a couple of questions you're gonna use with inquire in a second so I'm just gonna show you how to use this efficiently and make your application looks way move much more better than than in the old oral application using enquiring and Commander and some kind of like styling and colorful things and stuff like this so far as I've said for a program all you need to do is just use the program and this couple of methods one of them is the option so the option methods gonna provide you with enough lag so for example if you're familiar with passing in let's say our program called main tortillas then you pass in a flag so let's say for - - and or something and or just a shortcut for a or - people version or something less this is what going to do in this particular case so for the option here it gets a string the first thing is doing so let's say you want to give us an option of I don't know F and force but just for some operation over here the second one is description some forcing installing or force install for example some kind of description so you would know when you use help because program gonna provide you with an automatic help once you provide the help or once you need the help just type in that - help too give you an automatic help over here so the description gonna help him using or gonna help the commander in order for us to create the help section or the help message for the users this going to use this application the other one is they reject some rejects things so what this rejects are is like it provides them or it gives you a way for checking let's say you're gonna need only a number so you accept only a number so you can use some kind of phone and call back or function in you that gonna just go ahead and check for this if a name if it's actually number now so it can tell him that this is an error you must include or enter a number or something like this pretty similar but we're not gonna use it as I've said the last thing you can you also give it a default value for when the user do not enter anything in here so it's like the option thing whenever you enter it and after the option you need to parse the aren't humans you're gonna pass in so use a program and parse methods and you're gonna give it the arguments so we use the process the process the modular from node or node is this like main module it's always available for your application so the process gonna have or like some basic things like the arguments and a lot of things the argument VR given 0 a lot of OS specific things so we need to parse it in and to check if the option has been like triggered or if the user have said or set this optional now we use the program or we use F statement and program in dots the force force over here so make sure to name this the same as you have named this parameter not the first one the shortcut with the full option name so make sure to name is the same if you have here like add it was add over here and someone and so forth so this is like how are you checking it just gonna a boolean type whether true or false for the provider thing and I just try for console.log forcing for example for a Nokia type person yep now we'll try our program nodejs make sure to use now mint or Jason on the chicken compile it or run it using node and you would say we're gonna give it like - of course so subnets and just maximize this a bit so you can see what we are doing in as you can see we are forcing over here so it checks everything and it just gonna print us this really nice minified message so yeah this is how it works it's very very simple to provide it with options over here but what we need for application we don't need options alone so we're gonna need some commands or we need to provide us with commands so let's just get rid of this option and I'm gonna use the program doc command method and command method in all of us to provide him or feed it to him some custom commands for example so the first command we're gonna use let's say is context and this command is going to add a new concept into our database which we have like connected to it like up here so make sure to connect to it or if you're not familiar with MongoDB and you want to learn with it I have a for questions as I've said on my channel so just go ahead and check it out before watching this video tutorial lot understanding what we are actually doing over here so what's up set now using the command method we just give it an odd contacts for example and if you want to variable and for example we wanted the first name variable over here so make sure to use it like braces between between braces and you can put multiple variables over here or whatever like many variables or not Superman's not only one it supports multiple things and I don't know HTML over here so this is how we say this is gonna reference a variable then you can give it a description you can put the description between or the same thing here but using this method gonna allow you to use the action so make sure to do it like this description add new contacts and we using the action and the action is going to fire up once this command is going to stop man so once we submit the command let me just exit isn't clear so once you submit method into our program this action is going to fire up as the callback so take it as a callback over here and the action takes a callback and the callbacks takes the variables we're going to put in so when we put a first name it takes in the first name if you have multiple variables make sure to fill it in the milk to quote variables over here so make sure to use the same order as the variable referencing in here in order to make sure that everything's going to work fine no you're making like order of the variables really notice over here that we have permission to order them correctly let's say we're gonna cancel the log and then for example first me here well how the first name as I've said the auction and the description you must use the description method for some kind of like if you don't it's gonna gonna tell you that you need to create a new file for this command we're like you don't need it for this particular case but you can use it for much more bigger project you can check this out for in the disco or in the documentation of commander just serve it commander documentation and it's gonna help you a lot on understandable how this actually works it's pretty easier to know let's try note and mean genius and for example give it add contacts so make sure to like add the contact over here and let's give it its life universe for example so the name is this one purpose press Enter wait for the program to compile for a bit and yeah this is how we give it you can also provide here like own options so you give it a command and an options to the command so you let's say for example our contacts and some options like filter or add it at the end or us of the middle or some some kind of an options that you can provide using also the dots option so you can you include the top option method and you give it up in there and it just gonna work fine like very perfectly without no issues and you think the program can't use this since we are not using it correctly so let me just this again and run this again over again so as I've said out in your contact make sure to not be use your some like options are not being defined and anymore so just get rid of them and here we have no it means it's not venomous as you can see adding its lamp anyways so this is like working fine with no problems I said you can order custom options into you so we try now to have it unlike the real content extent your application or go into Oran our database so it get rid of this minimize this a bit in order to see what we're doing and if you scroll all the way down or all the way off actually and the violets we're connecting to the database or name and Anka database contact clicks you can use the campus since you like taking a closer look on our database on our data in there so I've put it just simple data on this database so if you can just go ahead into this database I've named it I believe a contact and a collection of contact let's take a collection as a table so always this so just put it to things like a name and a number so the name is Alex for example a number just some arbitrary number and Slam tournaments and a number another arbitrary yada-yada-yada so this is how we're going to insert a name and a number so just making it as simple as possible you can add a much more complicated attributes and different type of ideas over here but just make it as simple as possible over here I'm having a gender in here so let's just get rid of it since we're gonna just only need for the database to have the name and the number and through the skin and then we're confining the skin over here so we can use it down here so let's say when the option we are going to take the name and this is going to be name let me just change from the first name to name I'm gonna add a new variable is going to be the number so when you use your number or the new content campers over here beyond the number as well and yeah this is how it works fine and let's try to like I don't know use the database so let's say our model let's create a new model let's count tax for example using define you contacts I believe if I have this one in here so let me just scroll all the way up knowledge check if everything is working fine yeah the model name concept so everything is working fine let's passing the DNR we wants in here so the name it's going to be hot first remember so make sure to use name name and number number since they are the same or name the same as the keys and values so number and name now we can save this into the database using contacts I don't know why I'm using this pot okay don't save just for naming non naming combat conflicts so in this we are saving a subset and it takes a method so the method comes change yes first Lincoln error the second thing is let's name it city for contact just a shortcut every better also announce your contact and else we're just gonna console.log in fact cessful e and let's say for example here let's try to add some colorful things so let's try to add this concept of log and there's some kind of a green color just means that we have successfully added that into the database without or with no errors so for that we're gonna use the child because you can say so we have included it or required it's India up here so chalk is very very easy to use just using the chalk or the main constructor using if that's any given a method there's a different method like our RGB for a custom for custom colors sorry and you can use predefined methods let's say when I use those upset green not blue so green and let's give it the text it text you're going to take as yeah the same on so just I don't know what's happening to me I just I'm so confused doing this let's copy this text put it's all votes and we put this under a pulse of the log so we just copy this and also the block and at the end over that so this brings us a very very nice method that but just clear it's already been cleared but give it the add new contact the first name let's give it the number for example an arbitrary number I don't know something like this okay let's try to I don't know and we should waste contact unsuccessful as you can see we are getting a really nice green color and like the contacts on it successfully and yeah if you can go to the database we check for this like I don't know let's try the last one I have already slapped interest in the database so or I haven't so fresh this and refreshed it actually as I've said already the the database like already have in these videos in there so it just can't out of this two times but yeah it's working fine so let us clear knowledge use inquire for adding to the database so for The Enquirer you can just ask some questions and inquire can use some really really nice user interface or UI for you or to provide it to the user you want to ask questions let's say you why not like when the user type of contacts you start asking some questions one or step-by-step so the first question let's say you want to ask you're given your first name viewers your interest is first name press ENTER and you just ask another question give me your last name whatever give me your number something like this and so on and so forth you can ask him with checkboxes less and different different type of things so it can choose any and you can do custom checking as well so if you can see or as you can see we have I have already defined the questions array here which holds a couple of objects and that objects house type I type indicates which type we're gonna use which is the input so it's like a custom types from the Enquirer so we're gonna provide or feed in this questions into the mean Inquirer of prompt methods so it's just gonna render all of this like make sure to use it or alternates as you want so the first one is going to be the first one in here or the first one in the array is going to be the first question it's gone which is going to be asked to the user and so on and so forth so the name we're gonna use it for referencing that later on and a message to provide to the user here for the top of validates archability just gonna give it I'm giving it in here as you can see yes excellent talk just ESX syntax I'm giving it a function or a callback that's going to check if length just less than return please enter your first name else true so make sure to enter your your name not the link this year or so you haven't entered your name and so on and so forth it's just basic things input as well input and here for the gender I'm just having some kind of male and female but I'm not including it's really on the on the database so this makes no sense but just wanna show you how you can use less than here and how it can be very very nice to be used so not that you asks things like this so let's try to go ahead and just comment all of this code because I'm not gonna use the database right now so this comment is going use inquire itself I've already including point if you'll start in your projects and it has a couple of minutes over here so the prompt to methods gonna prompt us some questions it's gonna see it takes a questions it's going to be an array so we are part of need to find it out or predefined are there so I'm just gonna ask you them the questions and you can use the van method so van method is going to run once all of the questions are submitted and it's gonna take some answers and this answers using like an object and this object has a key value pairs each Key has the name gender so you can just provide gender it is gonna give you the answer you can provide numbering you're just gonna give you the phone number like have the objects words of value or key value pairs so it's really very nice and this is a callback actually so we try to provide a callback and yeah we can using console.log let's use chalk so chalk dance below let's now try blue and it just prints out all the answers that's once so now control save and let's run no let me just use the this keys and enter whatever number in here but we don't need this actually so let me try we can use it for now since inquire cannot like just ask us more questions and yeah but you can feel free to remove those because since you're gonna use require only so just remove all of the variables in here and remove them from here and you're ready to go so as you can see we've got your really nice like interface asking us enter your first name for example Islam or just my first name for last name let's say my real name by there is not a strength anyways so yeah just do not get confused enter your number for example just arbitrate number and it give me please enter a body number why does not happen you know just jump right into this I have a custom Bartlet function what if this function does this just takes a regular expression and compare it with our string or our number if just what I'm saying in here is you must take us maximum and minimum number of ten of check number so you must enter a number between 10 and 10 so the maximum of the minimum is 10 so you can't ask or you can enter more than 10 numbers or less than 10 members them or they actually the phone number must be 10 digits that's it that's it so very simple very basic as I've said you can use your own custom validation function in here which is pretty cool but try to add on 1 2 3 4 5 6 7 8 9 10 ten for the zero and your phone numbers can see it just get it and now select your gender use your arrow keys so using the arrow keys you're gonna give you really nice to select so you can select male or female and you aren't ready to go so let's say about try wanna select male I'm just watching I really hope you enjoy I really want the video to be very very long so that's why I'm cutting into over here I will catch you so anyway I will catch you in the next one