FM / commands

/snap/node/11782/lib/node_modules/npm/docs/content/commands/

/snap/node/11782/lib/node_modules/npm/docs/content/commands

Name	Size	Mode	Actions
npm-access.md	3664	0644	edit dl rm
npm-adduser.md	1847	0644	edit dl rm
npm-audit.md	15656	0644	edit dl rm
npm-bugs.md	2996	0644	edit dl rm
npm-cache.md	2962	0644	edit dl rm
npm-ci.md	9125	0644	edit dl rm
npm-completion.md	909	0644	edit dl rm
npm-config.md	4093	0644	edit dl rm
npm-dedupe.md	8895	0644	edit dl rm
npm-deprecate.md	1741	0644	edit dl rm
npm-diff.md	9109	0644	edit dl rm
npm-dist-tag.md	5181	0644	edit dl rm
npm-docs.md	2974	0644	edit dl rm
npm-doctor.md	5057	0644	edit dl rm
npm-edit.md	1091	0644	edit dl rm
npm-exec.md	11401	0644	edit dl rm
npm-explain.md	2795	0644	edit dl rm
npm-explore.md	1006	0644	edit dl rm
npm-find-dupes.md	6797	0644	edit dl rm
npm-fund.md	3673	0644	edit dl rm
npm-help-search.md	756	0644	edit dl rm
npm-help.md	1004	0644	edit dl rm
npm-hook.md	2394	0644	edit dl rm
npm-init.md	9855	0644	edit dl rm
npm-install-ci-test.md	7434	0644	edit dl rm
npm-install-test.md	9814	0644	edit dl rm
npm-install.md	24984	0644	edit dl rm
npm-link.md	11742	0644	edit dl rm
npm-login.md	2171	0644	edit dl rm
npm-logout.md	1749	0644	edit dl rm
npm-ls.md	8547	0644	edit dl rm
npm-org.md	1975	0644	edit dl rm
npm-outdated.md	5779	0644	edit dl rm
npm-owner.md	3093	0644	edit dl rm
npm-pack.md	3448	0644	edit dl rm
npm-ping.md	769	0644	edit dl rm
npm-pkg.md	8129	0644	edit dl rm
npm-prefix.md	1211	0644	edit dl rm
npm-profile.md	3102	0644	edit dl rm
npm-prune.md	5745	0644	edit dl rm
npm-publish.md	7622	0644	edit dl rm
npm-query.md	6958	0644	edit dl rm
npm-rebuild.md	5001	0644	edit dl rm
npm-repo.md	2754	0644	edit dl rm
npm-restart.md	1473	0644	edit dl rm
npm-root.md	1097	0644	edit dl rm
npm-run-script.md	7561	0644	edit dl rm
npm-sbom.md	8337	0644	edit dl rm
npm-search.md	3464	0644	edit dl rm
npm-shrinkwrap.md	923	0644	edit dl rm
npm-star.md	1713	0644	edit dl rm
npm-stars.md	743	0644	edit dl rm
npm-start.md	1667	0644	edit dl rm
npm-stop.md	1341	0644	edit dl rm
npm-team.md	4090	0644	edit dl rm
npm-test.md	1234	0644	edit dl rm
npm-token.md	2893	0644	edit dl rm
npm-uninstall.md	4447	0644	edit dl rm
npm-unpublish.md	4491	0644	edit dl rm
npm-unstar.md	1574	0644	edit dl rm
npm-update.md	11871	0644	edit dl rm
npm-version.md	6902	0644	edit dl rm
npm-view.md	5612	0644	edit dl rm
npm-whoami.md	800	0644	edit dl rm
npm.md	5670	0644	edit dl rm
npx.md	5895	0644	edit dl rm

Edit: /snap/node/11782/lib/node_modules/npm/docs/content/commands/npm-doctor.md (5057B)

---
title: npm-doctor
section: 1
description: Check the health of your npm environment
---

### Synopsis

```bash
npm doctor [connection] [registry] [versions] [environment] [permissions] [cache]
```

Note: This command is unaware of workspaces.

### Description

`npm doctor` runs a set of checks to ensure that your npm installation has
what it needs to manage your JavaScript packages. npm is mostly a
standalone tool, but it does have some basic requirements that must be met:

+ Node.js and git must be executable by npm.
+ The primary npm registry, `registry.npmjs.com`, or another service that
  uses the registry API, is available.
+ The directories that npm uses, `node_modules` (both locally and
  globally), exist and can be written by the current user.
+ The npm cache exists, and the package tarballs within it aren't corrupt.

Without all of these working properly, npm may not work properly.  Many
issues are often attributable to things that are outside npm's code base,
so `npm doctor` confirms that the npm installation is in a good state.

Also, in addition to this, there are also very many issue reports due to
using old versions of npm. Since npm is constantly improving, running
`npm@latest` is better than an old version.

`npm doctor` verifies the following items in your environment, and if
there are any recommended changes, it will display them.  By default npm
runs all of these checks. You can limit what checks are ran by
specifying them as extra arguments.

#### `Connecting to the registry`

By default, npm installs from the primary npm registry,
`registry.npmjs.org`.  `npm doctor` hits a special connection testing
endpoint within the registry. This can also be checked with `npm ping`.
If this check fails, you may be using a proxy that needs to be
configured, or may need to talk to your IT staff to get access over
HTTPS to `registry.npmjs.org`.

This check is done against whichever registry you've configured (you can
see what that is by running `npm config get registry`), and if you're using
a private registry that doesn't support the `/whoami` endpoint supported by
the primary registry, this check may fail.

#### `Checking npm version`

While Node.js may come bundled with a particular version of npm, it's the
policy of the CLI team that we recommend all users run `npm@latest` if they
can. As the CLI is maintained by a small team of contributors, there are
only resources for a single line of development, so npm's own long-term
support releases typically only receive critical security and regression
fixes. The team believes that the latest tested version of npm is almost
always likely to be the most functional and defect-free version of npm.

#### `Checking node version`

For most users, in most circumstances, the best version of Node will be the
latest long-term support (LTS) release. Those of you who want access to new
ECMAscript features or bleeding-edge changes to Node's standard library may
be running a newer version, and some may be required to run an older
version of Node because of enterprise change control policies. That's OK!
But in general, the npm team recommends that most users run Node.js LTS.

#### `Checking configured npm registry`

You may be installing from private package registries for your project or
company. That's great! Others may be following tutorials or StackOverflow
questions in an effort to troubleshoot problems you may be having.
Sometimes, this may entail changing the registry you're pointing at.  This
part of `npm doctor` just lets you, and maybe whoever's helping you with
support, know that you're not using the default registry.

#### `Checking for git executable in PATH`

While it's documented in the README, it may not be obvious that npm needs
Git installed to do many of the things that it does. Also, in some cases
– especially on Windows – you may have Git set up in such a way that it's
not accessible via your `PATH` so that npm can find it. This check ensures
that Git is available.

#### Permissions checks

* Your cache must be readable and writable by the user running npm.
* Global package binaries must be writable by the user running npm.
* Your local `node_modules` path, if you're running `npm doctor` with a
  project directory, must be readable and writable by the user running npm.

#### Validate the checksums of cached packages

When an npm package is published, the publishing process generates a
checksum that npm uses at install time to verify that the package didn't
get corrupted in transit. `npm doctor` uses these checksums to validate the
package tarballs in your local cache (you can see where that cache is
located with `npm config get cache`). In the event that there are corrupt
packages in your cache, you should probably run `npm cache clean -f` and
reset the cache.

### Configuration

#### `registry`

* Default: "https://registry.npmjs.org/"
* Type: URL

The base URL of the npm registry.

### See Also

* [npm bugs](/commands/npm-bugs)
* [npm help](/commands/npm-help)
* [npm ping](/commands/npm-ping)

cmd: