Documentation

npm - Manage node.js packages with npm

Synopsis

  • Manage node.js packages with Node Package Manager (npm)

Options

parameter required default choices comments
executable
no
The executable location for npm.
This is useful if you are using a version manager, such as nvm
global
no
  • yes
  • no
Install the node.js library globally
ignore_scripts
(added in 1.8)
no
  • yes
  • no
Use the --ignore-scripts flag when installing.
name
no
The name of a node.js library to install
path
no
The base path where to install the node.js libraries
production
no
  • yes
  • no
Install dependencies in production mode, excluding devDependencies
registry
(added in 1.6)
no
The registry to install modules from.
state
no present
  • present
  • absent
  • latest
The state of the node.js library
version
no
The version to be installed

Examples

- name: Install "coffee-script" node.js package.
  npm:
    name: coffee-script
    path: /app/location

- name: Install "coffee-script" node.js package on version 1.6.1.
  npm:
    name: coffee-script
    version: '1.6.1'
    path: /app/location

- name: Install "coffee-script" node.js package globally.
  npm:
    name: coffee-script
    global: yes

- name: Remove the globally package "coffee-script".
  npm:
    name: coffee-script
    global: yes
    state: absent

- name: Install "coffee-script" node.js package from custom registry.
  npm:
    name: coffee-script
    registry: 'http://registry.mysite.com'

- name: Install packages based on package.json.
  npm:
    path: /app/location

- name: Update packages based on package.json to their latest version.
  npm:
    path: /app/location
    state: latest

- name: Install packages based on package.json using the npm installed with nvm v0.10.1.
  npm:
    path: /app/location
    executable: /opt/nvm/v0.10.1/bin/npm
    state: present

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.