dependabot/npm_and_yarn/main/copy-to-clipboard-4.0.2
@reggi/path-to-regexp
dependabot/npm_and_yarn/main/copy-to-clipboard-4.0.2
dependabot/npm_and_yarn/main/eslint-10.4.0
dependabot/npm_and_yarn/main/npmcli/eslint-config-7.0.0
dependabot/npm_and_yarn/main/proc-log-7.0.0
dependabot/npm_and_yarn/npm_and_yarn-826852524d
dependabot/npm_and_yarn/npm_and_yarn-ab9a7f4bc2
deprecate-totp-2fa
dhei/classic-tokens
gat-bypass-2fa-docs
jpg619/fix-accessibility-content-flow
jpg619/version-bump-tar-2
kartykp/gat-bypass-2fa-docs
kartykp/upgrade-path-to-regex
main
maitxn/version-bump-tar
patch-1
reggi/cache-based-on-version
reggi/dev-engines
reggi/fix-transform-prettier
reggi/overrides
update-search-sensitivity
| 1 | --- |
| 2 | title: npm |
| 3 | section: 1 |
| 4 | description: javascript package manager |
| 5 | github_repo: npm/cli |
| 6 | github_branch: latest |
| 7 | github_path: docs/lib/content/commands/npm.md |
| 8 | redirect_from: |
| 9 | - /cli-commands/npm |
| 10 | - /cli-documentation/cli-commands/npm |
| 11 | - /cli-documentation/commands/npm |
| 12 | - /cli-documentation/npm |
| 13 | - /cli-documentation/v11/cli-commands/npm |
| 14 | - /cli-documentation/v11/commands/npm |
| 15 | - /cli-documentation/v11/npm |
| 16 | - /cli/cli-commands/npm |
| 17 | - /cli/commands/npm |
| 18 | - /cli/npm |
| 19 | - /cli/v11/cli-commands/npm |
| 20 | - /cli/v11/npm |
| 21 | - /commands/npm |
| 22 | --- |
| 23 | |
| 24 | ### Synopsis |
| 25 | |
| 26 | ```bash |
| 27 | npm |
| 28 | ``` |
| 29 | |
| 30 | Note: This command is unaware of workspaces. |
| 31 | |
| 32 | ### Version |
| 33 | |
| 34 | 11.16.0 |
| 35 | |
| 36 | ### Description |
| 37 | |
| 38 | npm is the package manager for the Node JavaScript platform. It puts modules in place so that node can find them, and manages dependency conflicts intelligently. |
| 39 | |
| 40 | It is extremely configurable to support a variety of use cases. Most commonly, you use it to publish, discover, install, and develop node programs. |
| 41 | |
| 42 | Run `npm help` to get a list of available commands. |
| 43 | |
| 44 | ### Important |
| 45 | |
| 46 | npm comes preconfigured to use npm's public registry at https://registry.npmjs.org by default. Use of the npm public registry is subject to terms of use available at https://docs.npmjs.com/policies/terms. |
| 47 | |
| 48 | You can configure npm to use any compatible registry you like, and even run your own registry. Use of someone else's registry is governed by their terms of use. |
| 49 | |
| 50 | ### Introduction |
| 51 | |
| 52 | You probably got npm because you want to install stuff. |
| 53 | |
| 54 | The very first thing you will most likely want to run in any node program is `npm install` to install its dependencies. |
| 55 | |
| 56 | You can also run `npm install blerg` to install the latest version of "blerg". Check out [`npm install`](/cli/v11/commands/npm-install) for more info. It can do a lot of stuff. |
| 57 | |
| 58 | Use the `npm search` command to show everything that's available in the public registry. Use `npm ls` to show everything you've installed. |
| 59 | |
| 60 | ### Dependencies |
| 61 | |
| 62 | If a package lists a dependency using a git URL, npm will install that dependency using the [`git`](https://github.com/git-guides/install-git) command and will generate an error if it is not installed. |
| 63 | |
| 64 | If one of the packages npm tries to install is a native node module and requires compiling of C++ Code, npm will use [node-gyp](https://github.com/nodejs/node-gyp) for that task. For a Unix system, [node-gyp](https://github.com/nodejs/node-gyp) needs Python, make and a buildchain like GCC. On Windows, Python and Microsoft Visual Studio C++ are needed. For more information visit [the node-gyp repository](https://github.com/nodejs/node-gyp) and the [node-gyp Wiki](https://github.com/nodejs/node-gyp/wiki). |
| 65 | |
| 66 | ### Directories |
| 67 | |
| 68 | See [`folders`](/cli/v11/configuring-npm/folders) to learn about where npm puts stuff. |
| 69 | |
| 70 | In particular, npm has two modes of operation: |
| 71 | |
| 72 | - local mode: npm installs packages into the current project directory, which defaults to the current working directory. Packages install to `./node_modules`, and bins to `./node_modules/.bin`. |
| 73 | - global mode: npm installs packages into the install prefix at `$NPM_CONFIG_PREFIX/lib/node_modules` and bins to `$NPM_CONFIG_PREFIX/bin`. |
| 74 | |
| 75 | Local mode is the default. Use `-g` or `--global` on any command to run in global mode instead. |
| 76 | |
| 77 | ### Developer Usage |
| 78 | |
| 79 | If you're using npm to develop and publish your code, check out the following help topics: |
| 80 | |
| 81 | - json: Make a package.json file. See [`package.json`](/cli/v11/configuring-npm/package-json). |
| 82 | - link: Links your current working code into Node's path, so that you don't have to reinstall every time you make a change. Use [`npm link`](/cli/v11/commands/npm-link) to do this. |
| 83 | - install: It's a good idea to install things if you don't need the symbolic link. Especially, installing other peoples code from the registry is done via [`npm install`](/cli/v11/commands/npm-install) |
| 84 | - adduser: Create an account or log in. When you do this, npm will store credentials in the user config file. |
| 85 | - publish: Use the [`npm publish`](/cli/v11/commands/npm-publish) command to upload your code to the registry. |
| 86 | |
| 87 | #### Configuration |
| 88 | |
| 89 | npm is extremely configurable. It reads its configuration options from 5 places. |
| 90 | |
| 91 | - Command line switches: Set a config with `--key val`. All keys take a value, even if they are booleans (the config parser doesn't know what the options are at the time of parsing). If you do not provide a value (`--key`) then the option is set to boolean `true`. |
| 92 | - Environment Variables: Set any config by prefixing the name in an environment variable with `NPM_CONFIG_`. For example, `export NPM_CONFIG_KEY=val`. |
| 93 | - User Configs: The file at `$HOME/.npmrc` is an ini-formatted list of configs. If present, it is parsed. If the `userconfig` option is set in the cli or env, that file will be used instead. |
| 94 | - Global Configs: The file found at `./etc/npmrc` (relative to the global prefix will be parsed if it is found. See [`npm prefix`](/cli/v11/commands/npm-prefix) for more info on the global prefix. If the `globalconfig` option is set in the cli, env, or user config, then that file is parsed instead. |
| 95 | - Defaults: npm's default configuration options are defined in `lib/utils/config/definitions.js`. These must not be changed. |
| 96 | |
| 97 | See [`config`](/cli/v11/using-npm/config) for much, much, more information. |
| 98 | |
| 99 | ### Contributions |
| 100 | |
| 101 | Patches welcome! |
| 102 | |
| 103 | If you would like to help, but don't know what to work on, read the [contributing guidelines](https://github.com/npm/cli/blob/latest/CONTRIBUTING.md) and check the issues list. |
| 104 | |
| 105 | ### Bugs |
| 106 | |
| 107 | When you find issues, please report them: [https://github.com/npm/cli/issues](https://github.com/npm/cli/issues) |
| 108 | |
| 109 | Please be sure to follow the template and bug reporting guidelines. |
| 110 | |
| 111 | ### Feature Requests |
| 112 | |
| 113 | Discuss new feature ideas on our discussion forum: |
| 114 | |
| 115 | - [https://github.com/orgs/community/discussions/categories/npm](https://github.com/orgs/community/discussions/categories/npm) |
| 116 | |
| 117 | Or suggest formal RFC proposals: |
| 118 | |
| 119 | - [https://github.com/npm/rfcs](https://github.com/npm/rfcs) |
| 120 | |
| 121 | ### See Also |
| 122 | |
| 123 | - [npm help](/cli/v11/commands/npm-help) |
| 124 | - [package.json](/cli/v11/configuring-npm/package-json) |
| 125 | - [npmrc](/cli/v11/configuring-npm/npmrc) |
| 126 | - [npm config](/cli/v11/commands/npm-config) |
| 127 | - [npm install](/cli/v11/commands/npm-install) |
| 128 | - [npm prefix](/cli/v11/commands/npm-prefix) |
| 129 | - [npm publish](/cli/v11/commands/npm-publish) |