INDEX.JS(1)

πŸ’– NAME πŸ’–

index.js β€” the npm tree doctor 🩺🌳


✨ DESCRIPTION ✨

okay so bestie, meet Arborist β€” the npm tree doctor πŸ‘‘ it's literally here to fix ur dependency tree's whole vibe.

Version: 9.7.0

Also, straight up, this page ships with this little gem in it:

Error: command 'undefined' does not exist.

yeah. iconic. anyway πŸ’…

🌸 USAGE 🌸

arborist <cmd> [path] [options...]

πŸ¦‹ COMMANDS πŸ¦‹

  • reify β€” reify the ideal tree into node_modules (this is ur install, update, rm, all of it, everything lives here)
  • prune β€” prune the ideal tree and then reify (basically npm prune)
  • ideal β€” generate the ideal tree and print it out
  • actual β€” read what's actually sitting in node_modules and print that tree
  • virtual β€” read the virtual tree from ur local shrinkwrap file and print it
  • shrinkwrap β€” load a local shrinkwrap and print its data
  • audit β€” run a security audit on ur project's dependencies πŸ”
  • funding β€” query funding info in the local package tree πŸ’Έ and psst: a second positional argument after the path name can limit this to one package name
  • license β€” query license info in the local package tree πŸ“œ and same deal: a second positional argument after the path name can limit it to one license type
  • help β€” print this text
  • version β€” print the version

πŸŽ€ OPTIONS πŸŽ€

Most npm options work here too, bestie β€” but they're in camelCase instead of css-case. no cap. so for example, instead of --dry-run, u use --dryRun. πŸ’…

Additionally:

  • --loglevel=warn / --quiet β€” suppresses the printing of package trees 🀫
  • --logfile <file|bool> β€” writes ur logs out to a file
  • --timing β€” shows timing information ⏱️
  • instead of npm install <pkg>, u say arborist reify --add=<pkg> β€” and heads up, the --add=<pkg> option can be specified multiple times ✨
  • instead of npm rm <pkg>, u say arborist reify --rm=<pkg> β€” and yep, the --rm=<pkg> option can be specified multiple times too
  • instead of npm update, u say arborist reify --update-all πŸ”₯
  • and npm audit fix is literally just arborist audit --fix πŸ‘‘
lowkey the whole flex here is: whatever npm does, arborist does it too, u just gotta speak camelCase. periodt.

and that's the whole page, bestie 🫢 this was index.js version 9.7.0, from July 2026, sitting in section INDEX.JS(1) of the manual. slay, go doctor some trees πŸŒ³πŸ’–

πŸ“¦ where this page comes from