Node.js Yargs Module

Last Updated : 08 Oct, 2021

Yargs module is used for creating your own command-line commands in node.js and helps in generating an elegant user interface. This module makes command-line arguments flexible and easy to use.

Installation of yargs module:

You can visit the link Install yargs module. You can install this package by using this command.
```
npm install yargs
```
After installing yargs you can check your yargs version in command prompt using the command.
```
npm version yargs
```
After that, you can just create a folder and add a file for example index.js, To run this file you need to run the following command.
```
node index.js
```

Filename: index.js

const yargs = require('yargs') 
   
// Customize yargs version 
yargs.version('1.1.0') 
   
// Create add command 
yargs.command({ 
    command: 'add', 
    describe: 'Adds two number', 
    builder: { 
        firstNumber: { 
            describe: 'First Number', 
            demandOption: true,  // Required 
            type: 'number'     
        }, 
        secondNumber: {   
            describe: 'Second Number', 
            demandOption: true, 
            type: 'number'
        } 
    }, 
  
    // Function for your command 
    handler(argv) { 
        console.log("Result:",  
            (argv.firstNumber+argv.secondNumber)) 
    } 
}) 
   
yargs.parse() // To set above changes 

Steps to run the program:

The project structure will look like this:
Make sure you have install express and yargs module using following commands:
```
npm install express
npm install yargs
```
Run index.js file using below command:
```
node index.js
```
After running this above command, now yargs command is set, you can use it as shown below:
```
node index.js add --firstNumber=4 --secondNumber=10
```

So this is how you can use yargs module for making your own command-line arguments command thereby making it more interactive.

Node.js Redis Module

gouravhammad

News

Improve

Article Tags :

Similar Reads

Node.js Yargs Module

Yargs module is used for creating your own command-line commands in node.js and helps in generating an elegant user interface. This module makes command-line arguments flexible and easy to use. Installation of yargs module: You can visit the link Install yargs module. You can install this package by

Node.js Redis Module

Redis is an Open Source store for storing data structures. It is used in multiple ways. It is used as a database, cache, and message broker. It can store data structures such as strings, hashes, sets, sorted sets, bitmaps, indexes, and streams. Redis is very useful for Node.js developers as it reduc

Node.js Request Module

The request module in Node is used to make HTTP requests. It allows developers to simply make HTTP requests like GET, POST, PUT, and DELETE in the Node app. It follows redirects by default. Syntax:const request = require('request'); request(url, (error, response, body) => { if (!error &&

Node.js Modules

Modules in Node.js are blocks of encapsulated code that can be reused throughout your application. These modules can include functions, objects, and variables that are exported from the code files. In this article, we’ll cover the basics of Node.js modules, the different types of modules, how to cre

Node.js Modules

Modules in Node.js are blocks of encapsulated code that can be reused throughout your application. These modules can include functions, objects, and variables that are exported from the code files. In this article, we’ll cover the basics of Node.js modules, the different types of modules, how to cre

Node.js require Module

The primary object exported by the require() module is a function. When NodeJS invokes this require() function, it does so with a singular argument - the file path. This invocation triggers a sequence of five pivotal steps: Resolving and Loading: The process begins with the resolution and loading of

Node.js HTTP Module

Node.js HTTP module allows you to create and manage web servers and handle HTTP requests and responses. Unlike other frameworks like Express.js, the HTTP module is built directly into Node.js, meaning you don't need to install any additional packages. It provides low-level control over HTTP requests

Node.js Local Module

A local module in Node.js refers to a custom module created in an application. Unlike the built in or third-party modules, local modules are specific to the project and are used to organize and reuse your code across different parts of your application. Local Module in Node.jsLocal modules in Node.j

Node.js Chalk Module

Chalk module in Node.js is the third-party module that is used for styling the format of text and allows us to create our own themes in the node.js project. Advantages of Chalk Module: It helps to customize the color of the output of the command-line outputIt helps to improve the quality of the outp

What are modules in Node JS ?

In NodeJS, modules are encapsulated units of code that can be reused across different parts of an application. Modules help organize code into smaller, manageable pieces, promote code reusability, and facilitate better maintainability and scalability of NodeJS applications. Types of Modules:Core Mod

What are Modules in Node.js ?

In Node.js Application, a Module can be considered as a block of code that provide a simple or complex functionality that can communicate with external application. Modules can be organized in a single file or a collection of multiple files/folders. Almost all programmers prefer modules because of t

Node.js nodemon npm Module

The nodemon npm Module is a module that develop node.js based applications by automatically restarting the node application when file changes in the directory are detected. Nodemon does not require any change in the original code and method of development. Advantages of Using nodemon Module: It is e

Node Export Module

In Node, the `module.exports` is utilized to expose literals, functions, or objects as modules. This mechanism enables the inclusion of JavaScript files within Node.js applications. The `module` serves as a reference to the current module, and `exports` is an object that is made accessible as the mo

Node Export Module

In Node, the `module.exports` is utilized to expose literals, functions, or objects as modules. This mechanism enables the inclusion of JavaScript files within Node.js applications. The `module` serves as a reference to the current module, and `exports` is an object that is made accessible as the mo

The os module in Node.js provides operating system-related utility methods and properties. It helps retrieve system information such as CPU details, memory usage, and network interfaces, enabling you to write system-aware applications. It provides functions to interact with the operating system. It

Node.js package.json

The package.json file is the heart of Node.js system. It is the manifest file of any Node.js project and contains the metadata of the project. The package.json file is the essential part to understand, learn and work with the Node.js. It is the first step to learn about development in Node.js. What

How to use 'Kleur' Module in Node.js ?

'kleur' module is an external NPM module that can manage color properties in JavaScript applications or projects. It allows developers or programmers to manipulate and use colors in their projects. By using kleur, we change the colors of the outputs in the console which make it looks good. Installat

Modules in NestJS

NestJS is a progressive Node.js framework that has gained significant popularity for building efficient, reliable, and scalable server-side applications. One of its core concepts is the use of modules, which help in organizing the application. In this article, we’ll learn what modules are, why they

How To Create Modules in Node.js?

Node.js modules allow you to encapsulate functionality in separate files and reuse them across different parts of an application. A module in Node.js is simply a reusable piece of code that can contain variables, functions, classes, or objects. To create a module in Node.js, you will need the export

翻译：