UNPKG

1.28 kBMarkdownView Raw
1# nls [![npm-version][npm-badge]][npm-link] [![install size][pp-badge]][pp-link]
2
3Missing inspector for npm packages.
4
5```bash
6npm install -g nls
7```
8
9![nls-screenshot][screenshot]
10
11## Usage
12
13```bash
14Usage
15
16 $ nls [<target-dir>] List available npm scripts.
17 $ nls why <package-name> Identify why a package has been installed.
18 $ nls read <package-name> Print readme file for a specified package.
19
20Options
21
22 -h, --help Output usage information
23 -v, --version Output the version number
24
25Examples
26
27 # List npm scripts in current dir
28 $ nls
29
30 # List npm scripts in "node_modules/chalk"
31 $ nls node_modules/chalk
32
33 # Find who depend upon package 'chalk'.
34 $ nls why chalk
35
36 # Print readme file for 'glob'
37 $ nls read glob
38```
39
40## Related
41
42- [yarn-why](https://github.com/amio/yarn-why) - Identifies why a package has been installed (with `yarn.lock`)
43- [npm-why](https://github.com/amio/npm-why) - Identifies why a package has been installed (with `package-lock.json`)
44
45## License
46
47MIT @ Amio
48
49[screenshot]: ./nls-screenshot.png
50[amio-link]: https://github.com/amio
51[npm-badge]: https://badgen.net/npm/v/nls
52[npm-link]: https://www.npmjs.com/package/nls
53[pp-badge]: https://badgen.net/packagephobia/install/nls
54[pp-link]: https://packagephobia.now.sh/result?p=nls