https://github.com/npm/npm-remote-ls
Examine a package's dependency graph before you install it
https://github.com/npm/npm-remote-ls
Last synced: 10 months ago
JSON representation
Examine a package's dependency graph before you install it
- Host: GitHub
- URL: https://github.com/npm/npm-remote-ls
- Owner: npm
- License: isc
- Archived: true
- Created: 2014-07-09T17:00:10.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2021-06-28T15:24:59.000Z (about 5 years ago)
- Last Synced: 2025-01-13T14:13:29.744Z (over 1 year ago)
- Language: JavaScript
- Size: 41 KB
- Stars: 90
- Watchers: 29
- Forks: 36
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# npm-remote-ls
[](https://travis-ci.org/npm/npm-remote-ls)
[](https://coveralls.io/r/npm/npm-remote-ls?branch=master)
[](https://www.npmjs.com/package/npm-remote-ls)
[](https://github.com/conventional-changelog/standard-version)
Examine a package's dependency graph before you install it.
## Installation
```bash
npm install npm-remote-ls -g
```
## Usage
### Listing Package Dependencies
```
npm-remote-ls sha@1.2.4
└─ sha@1.2.4
├─ readable-stream@1.0.27-1
│ ├─ isarray@0.0.1
│ ├─ string_decoder@0.10.25
│ ├─ inherits@2.0.1
│ └─ core-util-is@1.0.1
└─ graceful-fs@3.0.2
```
### Help!
There are various command line flags you can toggle for `npm-remote-ls`, for
details run:
```bash
npm-remote-ls --help
```
## API
**Return dependency graph for `latest` version:**
```javascript
var ls = require('npm-remote-ls').ls;
ls('grunt', 'latest', function(obj) {
console.log(obj);
});
```
**Return dependency graph for specific version:**
```javascript
var ls = require('npm-remote-ls').ls;
ls('grunt', '0.1.0', function(obj) {
console.log(obj);
});
```
**Return a flattened list of dependencies:**
```javascript
var ls = require('npm-remote-ls').ls;
ls('grunt', '0.1.0', true, function(obj) {
console.log(obj);
});
```
**Configure to only return production dependencies:**
```javascript
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:**
```javascript
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)
})
```
## License
ISC