npm-login-noninteractive

Allows you to log in to NPM without STDIN, STDOUT. Use in places like CI build systems. Also creates/modifies entries in the ~/.npmrc file for authentication.

Installation

npm install -g npm-login-noninteractive

Use -g flag to use npm-login-noninteractive via the CLI

Usage

CLI

npm-login-noninteractive expects the following environment variables to be set before you can use it to authenticate:

NPM_USER: NPM username
NPM_PASS: NPM password
NPM_EMAIL: NPM email
NPM_REGISTRY: (optional) Private NPM registry to log in to (Default: https://registry.npmjs.org)
NPM_SCOPE: (optional) Private NPM scope
NPM_RC_PATH: (optional) Path to a custom .npmrc file you want to update (Default: ~/) (Do note this is the path of the file, not the file itself)

Once the required ones are set, you can just run the following to log in:

npm-login-noninteractive

You can also export variables and run it all in one line:

NPM_USER=testUser NPM_PASS=testPass NPM_EMAIL=test@example.com npm-login-noninteractive

There is also support for command line arguments:

-u: NPM Username
-p: NPM Password
-e: NPM Email
-r: NPM Registry
-s: NPM Scope
--config-path: Set to ~/ by default. Can be used to configure a custom .npmrc file to edit (Do note this is the path of the file, not the file itself)

For example: npm-login-noninteractive -u testUser -p testPass -e test@example.com

Or: npm-login-noninteractive -u testUser -p testPass -e test@example.com -r https://private.npm.com -s @privateNPM --config-path="./custom/path/"

Do note that at least one of the two ways must be configured, that is, you must either provide the required fields (username, password and email) using the environment variables or the command line arguments (or both)

Programmatic API

To use the package programmatically, just require the module and pass in your NPM auth details as arguments:

const npmLogin = require('npm-login-noninteractive');
 
npmLogin(username, password, email [, registry, scope, quotes, configPath]);

Example

Logging in to the NPM registry:

const npmLogin = require('npm-login-noninteractive');
 
const username = 'testUser';
const password = 'testPass';
const email = 'test@example.com';
 
npmLogin(username, password, email);

Logging in to private NPM registries:

const npmLogin = require('npm-login-noninteractive');
 
const username = 'testUser';
const password = 'testPass';
const email = 'test@example.com';
const registry = 'https://npm.example.com';
const scope = '@myScope';
const configPath = './custom/path/';
 
npmLogin(username, password, email, registry, scope, configPath);