salt.modules.npm¶

Manage and query NPM packages.

salt.modules.npm.install(pkg=None, pkgs=None, dir=None, runas=None, registry=None, env=None)¶

Install an NPM package.

If no directory is specified, the package will be installed globally. If no package is specified, the dependencies (from package.json) of the package in the given directory will be installed.

pkg

A package name in any format accepted by NPM, including a version identifier

pkgs

A list of package names in the same format as the name parameter

New in version 2014.7.0.

dir

The target directory in which to install the package, or None for global installation

runas

The user to run NPM with

registry

The NPM registry to install the package from.

New in version 2014.7.0.

env

Environment variables to set when invoking npm. Uses the same env format as the cmd.run execution function.

New in version 2014.7.0.

CLI Example:

salt '*' npm.install coffee-script

salt '*' npm.install coffee-script@1.0.1

salt.modules.npm.list(pkg=None, dir=None, runas=None, env=None)¶

List installed NPM packages.

If no directory is specified, this will return the list of globally- installed packages.

pkg

Limit package listing by name

dir

The directory whose packages will be listed, or None for global installation

runas

The user to run NPM with

New in version 2014.7.0.

env

Environment variables to set when invoking npm. Uses the same env format as the cmd.run execution function.

New in version 2014.7.0.

CLI Example:

salt '*' npm.list

salt.modules.npm.uninstall(pkg, dir=None, runas=None)¶

Uninstall an NPM package.

If no directory is specified, the package will be uninstalled globally.

pkg

A package name in any format accepted by NPM

dir

The target directory from which to uninstall the package, or None for global installation

runas

The user to run NPM with

CLI Example:

salt '*' npm.uninstall coffee-script