Skip to content
Related Articles
Get the best out of our app
GeeksforGeeks App
Open App

Related Articles

How to Install a local module using npm?

Improve Article
Save Article
Like Article
Improve Article
Save Article
Like Article

Introduction :  

This article shows how to install local module using npm.

Local modules are modules created locally in your Node.js application to create user-required functionality. These local modules include different functionalities of your application in separate files and folders. To link the local module first you must have the local module directory or package directory. 

npm (Node Package Manager) is the default package manager for Node.js, know more about npm here.

Why do we use local modules?

We use local modules to create the user required functionality in an application made using Node.js. Know more about Node.js here.

    How to install local modules?

  1. Using npm-link

        Go to the local module directory ( package you want to install ) and enter this command.

    npm link

    output of the above command

    Go to the project directory where you want to install the local module and enter this command.  

    npm link package-name

    output of the above command

    Example: Let the local-dir is the local directory and project-dir is the project directory and local_module is the local module package you want to install, first go to the local-dir and type npm link and next go to the project directory and type npm link <local_module> this will link your local module to your project.

  2. Using npm install

    We need to provide <folder> argument to npm install, The argument should be the local folder where the package is present, Path is the location of the folder containing the package ( local_module ) you want to install

    npm install /path

    output of the above code

    Example: Let the path where your local module stored is C:\Users\engineer\Desktop\package. Now go the project directory and type the command npm install C:\Users\engineer\Desktop\package

    NOTE: Just provide the package folder name but not the package name, it will automatically link it to your project.

How to uninstall a package installed with an npm link:
The program may be uninstalled using the same uninstall or rm order as is used to delete installed packages. The only thing to note is that the connection must be uninstalled globally the global flag must be defined.

The following command can be used to remove the globally connected foo kit

npm rm --global foo
My Personal Notes arrow_drop_up
Last Updated : 06 Oct, 2021
Like Article
Save Article
Similar Reads
Related Tutorials