salt.modules.npm
Manage and query NPM packages.
-
Clean cached NPM packages.
If no path for a specific package is provided the entire cache will be cleared.
- path
-
The cache subpath to delete, or None to clear the entire cache
- runas
-
The user to run NPM with
- env
-
Environment variables to set when invoking npm. Uses the same
env
format as thecmd.run
execution function. - force
-
Force cleaning of cache. Required for npm@5 and greater
New in version 2016.11.6.
CLI Example:
salt '*' npm.cache_clean force=True
salt.modules.npm.cache_clean(path=None, runas=None, env=None, force=False)
-
List NPM cached packages.
If no path for a specific package is provided this will list all the cached packages.
- path
-
The cache subpath to list, or None to list the entire cache
- runas
-
The user to run NPM with
- env
-
Environment variables to set when invoking npm. Uses the same
env
format as thecmd.run
execution function.
CLI Example:
salt '*' npm.cache_clean
salt.modules.npm.cache_list(path=None, runas=None, env=None)
-
List path of the NPM cache directory.
- runas
-
The user to run NPM with
- env
-
Environment variables to set when invoking npm. Uses the same
env
format as thecmd.run
execution function.
CLI Example:
salt '*' npm.cache_path
salt.modules.npm.cache_path(runas=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
parameterNew 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 thecmd.run
execution function.New in version 2014.7.0.
- silent
-
Whether or not to run NPM install with --silent flag.
New in version 2016.3.0.
- dry_run
-
Whether or not to run NPM install with --dry-run flag.
New in version 2015.8.4.
- silent
-
Whether or not to run NPM install with --silent flag.
New in version 2015.8.5.
CLI Example:
salt '*' npm.install coffee-script salt '*' npm.install [email protected]
salt.modules.npm.install(pkg=None, pkgs=None, dir=None, runas=None, registry=None, env=None, dry_run=False, silent=True)
-
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 thecmd.run
execution function.New in version 2014.7.0.
- depth
-
Limit the depth of the packages listed
New in version 2016.11.6,2017.7.0.
CLI Example:
salt '*' npm.list
salt.modules.npm.list_(pkg=None, dir=None, runas=None, env=None, depth=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
- env
-
Environment variables to set when invoking npm. Uses the same
env
format as thecmd.run
execution function.New in version 2015.5.3.
CLI Example:
salt '*' npm.uninstall coffee-script
salt.modules.npm.uninstall(pkg, dir=None, runas=None, env=None)
© 2021 SaltStack.
Licensed under the Apache License, Version 2.0.
https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.npm.html