npm-remote-ls's Introduction

npm-remote-ls

Examine a package's dependency graph before you install it.

Installation

npm install npm-remote-ls -g

Usage

Listing Package Dependencies

npm-remote-ls [email protected]

└─ [email protected]
   ├─ [email protected]
   │  ├─ [email protected]
   │  ├─ [email protected]
   │  ├─ [email protected]
   │  └─ [email protected]
   └─ [email protected]

Help!

There are various command line flags you can toggle for npm-remote-ls, for details run:

npm-remote-ls --help

API

Return dependency graph for latest version:

var ls = require('npm-remote-ls').ls;

ls('grunt', 'latest', function(obj) {
  console.log(obj);
});

Return dependency graph for specific version:

var ls = require('npm-remote-ls').ls;

ls('grunt', '0.1.0', function(obj) {
  console.log(obj);
});

Return a flattened list of dependencies:

var ls = require('npm-remote-ls').ls;

ls('grunt', '0.1.0', true, function(obj) {
  console.log(obj);
});

Configure to only return production dependencies:

var ls = require('npm-remote-ls').ls
var config = require('npm-remote-ls').config

config({
  development: false,
  optional: false
})

ls('yargs', 'latest', true, function (obj) {
  console.log(obj)
})

Configure to return peer dependencies:

var ls = require('npm-remote-ls').ls
var config = require('npm-remote-ls').config

config({
  development: true,
  peer: true
})

ls('grunt-contrib-coffee', 'latest', true, function (obj) {
  console.log(obj)
})