Skip to content

npm-explain: add page #19023

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+20 −0
Open

npm-explain: add page #19023

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b7bd0cf
Add TLDR page for npm explain — explains why a package is installed a…
Ahamed1846 Oct 24, 2025
37daeaa
Merge branch 'main' into add-npm-explain-page
Ahamed1846 Oct 24, 2025
844441b
Update pages/common/npm-explain.md
Ahamed1846 Oct 25, 2025
54fa013
Merge branch 'main' into add-npm-explain-page
Ahamed1846 Oct 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions pages/common/npm-explain.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# npm explain

> Explain how a package is installed, detailing its dependencies and reasons for inclusion.
> More information: <https://docs.npmjs.com/cli/explain>.

- Explain why a specific package is installed:

`npm explain {{package_name}}`

- Show explanation in JSON format:

`npm explain {{package_name}} --json`

- Include peer dependencies in the explanation:

`npm explain {{package_name}} --include peer`

- Limit explanation depth to 2 levels deep:

`npm explain {{package_name}} --depth 2`