.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH INDEX.JS "1" "November 2023" "index.js 6.1.5" "User Commands"
.SH NAME
index.js \- the npm tree doctor
.SH DESCRIPTION
Arborist \- the npm tree doctor
.PP
Version: 6.1.5
.PP
Error: command 'undefined' does not exist.
.PP
# USAGE
.IP
arborist <cmd> [path] [options...]
.PP
# COMMANDS
.IP
* reify: reify ideal tree to node_modules (install, update, rm, ...)
* prune: prune the ideal tree and reify (like npm prune)
* ideal: generate and print the ideal tree
* actual: read and print the actual tree in node_modules
* virtual: read and print the virtual tree in the local shrinkwrap file
* shrinkwrap: load a local shrinkwrap and print its data
* audit: perform a security audit on project dependencies
* funding: query funding information in the local package tree.  A second
.IP
positional argument after the path name can limit to a package name.
.TP
* license: query license information in the local package tree.
A second
.IP
positional argument after the path name can limit to a license type.
.IP
* help: print this text
* version: print the version
.PP
# OPTIONS
.TP
Most npm options are supported, but in camelCase rather than css\-case.
For
.IP
example, instead of '\-\-dry\-run', use '\-\-dryRun'.
.IP
Additionally:
.IP
* \fB\-\-loglevel\fR=\fI\,warn\/\fR|\-\-quiet will supppress the printing of package trees
* \fB\-\-logfile\fR <file|bool> will output logs to a file
* \fB\-\-timing\fR will show timing information
* Instead of 'npm install <pkg>', use 'arborist reify \fB\-\-add=\fR<pkg>'.
.IP
The '\-\-add=<pkg>' option can be specified multiple times.
.IP
* Instead of 'npm rm <pkg>', use 'arborist reify \fB\-\-rm=\fR<pkg>'.
.IP
The '\-\-rm=<pkg>' option can be specified multiple times.
.IP
* Instead of 'npm update', use 'arborist reify \fB\-\-update\-all\fR'.
* 'npm audit fix' is 'arborist audit \fB\-\-fix\fR'