NPM-LS(1)

πŸ’… npm-ls(1) β€” the manual page, bestie edition

okay so you opened npm-ls(1) and you want the tea. this is the npm ls page from the npm manual, and I'm gonna walk you through literally every bit of it. no skips, no vibes-based summarising. 🫢


✨ NAME ✨

npm-ls β€” List installed packages πŸŽ€

🌸 Synopsis

npm ls <package-spec>

alias: list


πŸ’– DESCRIPTION πŸ’–

This command will print to stdout all the versions of packages that are installed, plus their dependencies when --all is specified, all in a tree structure. it's giving family tree but make it node_modules 🌳✨

Note: if you want a "bottoms up" view of why a given package is even in the tree at all, use npm help explain. that's the detective edition, this one is the family photo.

Positional arguments are name@version-range identifiers, which will limit the results to only the paths to the packages named. lowkey note that nested packages will also show the paths to the specified packages. for example, running npm ls promzard in npm's source tree will show:

npm@12.2.1 /path/to/npm
└─┬ init-package-json@0.0.4
  └── promzard@0.1.5

It will print out extraneous, missing, and invalid packages. the trio of chaos πŸ’€

If a project specifies git urls for dependencies, these are shown in parentheses after the name@version so it's way easier for users to recognize potential forks of a project. iykyk πŸ”₯

The tree shown is the logical dependency tree, based on package dependencies β€” not the physical layout of your node_modules folder. so don't come for me with "but the folder looks different", they're different things bestie.

When run as ll or la, it shows extended information by default. cute shortcuts, obsessed.


πŸ¦‹ CONFIGURATION πŸ¦‹

⭐ all

  • Default: false
  • Type: Boolean

Show or act on all packages, not just the ones your project directly depends on. For npm outdated and npm ls this lists every outdated or installed package. For npm approve-scripts and npm deny-scripts it selects every package with pending install scripts.

⭐ json

  • Default: false
  • Type: Boolean

Whether or not to output JSON data, rather than the normal output.

  • In npm pkg set it enables parsing set values with JSON.parse() before saving them to your package.json.

Not supported by all npm commands. πŸ™ˆ

⭐ long

  • Default: false
  • Type: Boolean

Show extended information in ls, search, and help-search. the "give me the whole lore" setting πŸ“š

⭐ parseable

  • Default: false
  • Type: Boolean

Output parseable results from commands that write to standard output. For npm search, this will be tab-separated table format.

⭐ global

  • Default: false
  • Type: Boolean

Operates in "global" mode, so that packages are installed into the prefix folder instead of the current working directory. See npm help folders for more on the differences in behavior.

  • packages are installed into the {prefix}/lib/node_modules folder, instead of the current working directory.
  • bin files are linked to {prefix}/bin
  • man pages are linked to {prefix}/share/man

⭐ depth

  • Default: Infinity if --all is set; otherwise, 0
  • Type: null or Number

The depth to go when recursing packages for npm ls.

If not set, npm ls will show only the immediate dependencies of the root project. If --all is set, then npm will show all dependencies by default. 🌈

⭐ omit

  • Default: 'dev' if the NODE_ENV environment variable is set to 'production'; otherwise, empty.
  • Type: "dev", "optional", or "peer" (can be set multiple times)

Dependency types to omit from the installation tree on disk.

Note that these dependencies are still resolved and added to the package-lock.json file. They are just not physically installed on disk. the lockfile keeps the receipts, the disk doesn't πŸ’…

If a package type appears in both the --include and --omit lists, then it will be included.

If the resulting omit list includes 'dev', then the NODE_ENV environment variable will be set to 'production' for all lifecycle scripts.

⭐ include

  • Default: (empty)
  • Type: "prod", "dev", "optional", or "peer" (can be set multiple times)

Option that allows for defining which types of dependencies to install.

This is the inverse of --omit=<type>.

Dependency types specified in --include will not be omitted, regardless of the order in which omit/include are specified on the command-line. order does NOT matter, and that's iconic ✨

  • Default: false
  • Type: Boolean

Used with npm ls, limiting output to only those packages that are linked. πŸ”—

⭐ package-lock-only

  • Default: false
  • Type: Boolean

If set to true, the current operation will only use the package-lock.json, ignoring node_modules.

For update this means only the package-lock.json will be updated, instead of checking node_modules and downloading dependencies.

For list this means the output will be based on the tree described by the package-lock.json, rather than the contents of node_modules.

⭐ unicode

  • Default: false on windows, true on mac/unix systems with a unicode locale, as defined by the LC_ALL, LC_CTYPE, or LANG environment variables.
  • Type: Boolean

When set to true, npm uses unicode characters in the tree output. When false, it uses ascii characters instead of unicode glyphs. so that's why your tree has cute little └─┬ lines on mac and sad little ascii on windows 😭

⭐ workspace

  • Default: (empty)
  • Type: String (can be set multiple times)

Enable running a command in the context of the configured workspaces of the current project while filtering by running only the workspaces defined by this configuration option.

Valid values for the workspace config are either:

  • Workspace names
  • Path to a workspace directory
  • Path to a parent workspace directory (will result in selecting all workspaces within that folder)

When set for the npm init command, this may be set to the folder of a workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project. main character energy for a folder that isn't even born yet πŸ‘‘

This value is not exported to the environment for child processes.

⭐ workspaces

  • Default: null
  • Type: null or Boolean

Set to true to run the command in the context of all configured workspaces.

Explicitly setting this to false will cause commands like install to ignore workspaces altogether. When not set explicitly:

  • Commands that operate on the node_modules tree (install, update, etc.) will link workspaces into the node_modules folder.
  • Commands that do other things (test, exec, publish, etc.) will operate on the root project, unless one or more workspaces are specified in the workspace config.

This value is not exported to the environment for child processes.

⭐ include-workspace-root

  • Default: false
  • Type: Boolean

Include the workspace root when workspaces are enabled for a command.

When false, specifying individual workspaces via the workspace config, or all workspaces via the workspaces flag, will cause npm to operate only on the specified workspaces, and not on the root project.

This value is not exported to the environment for child processes.

  • Default: false
  • Type: Boolean

When set, file: protocol dependencies will be packed and installed as regular dependencies instead of creating a symlink. This option has no effect on workspaces.


πŸ‘‘ SEE ALSO πŸ‘‘

  • npm help "package spec"
  • npm help explain
  • npm help config
  • npm help npmrc
  • npm help folders
  • npm help explain
  • npm help install
  • npm help link
  • npm help prune
  • npm help outdated
  • npm help update

(and yes, npm help explain is literally in there twice β€” I'm not the one who wrote it, I'm just the one who respects the source material πŸ’€πŸ’–)


that's the whole page, every option, every default, every path, every env var, nothing skipped, periodt.

sign-off time πŸŽ€ β€” this was npm-ls(1), from the npm manual, version NPM@12.2.1, dated October 2026. go forth and read your dependency tree bestie 🌸✨

πŸ“¦ where this page comes from