| 1 | # npm - a JavaScript package manager
|
| 2 |
|
| 3 | [](https://npm.im/npm)
|
| 4 | [](https://npm.im/npm)
|
| 5 | [](https://github.com/npm/cli/actions/workflows/ci.yml)
|
| 6 | [](https://github.com/npm/cli/actions/workflows/benchmark.yml)
|
| 7 |
|
| 8 | ### Requirements
|
| 9 |
|
| 10 | One of the following versions of [Node.js](https://nodejs.org/en/download/) must be installed to run **`npm`**:
|
| 11 |
|
| 12 | * `18.x.x` >= `18.17.0`
|
| 13 | * `20.5.0` or higher
|
| 14 |
|
| 15 | ### Installation
|
| 16 |
|
| 17 | **`npm`** comes bundled with [**`node`**](https://nodejs.org/), & most third-party distributions, by default. Officially supported downloads/distributions can be found at: [nodejs.org/en/download](https://nodejs.org/en/download)
|
| 18 |
|
| 19 | #### Direct Download
|
| 20 |
|
| 21 | You can download & install **`npm`** directly from [**npmjs**.com](https://npmjs.com/) using our custom `install.sh` script:
|
| 22 |
|
| 23 | ```bash
|
| 24 | curl -qL https://www.npmjs.com/install.sh | sh
|
| 25 | ```
|
| 26 |
|
| 27 | #### Node Version Managers
|
| 28 |
|
| 29 | If you're looking to manage multiple versions of **`Node.js`** &/or **`npm`**, consider using a [node version manager](https://github.com/search?q=node+version+manager+archived%3Afalse&type=repositories&ref=advsearch)
|
| 30 |
|
| 31 | ### Usage
|
| 32 |
|
| 33 | ```bash
|
| 34 | npm <command>
|
| 35 | ```
|
| 36 |
|
| 37 | ### Links & Resources
|
| 38 |
|
| 39 | * [**Documentation**](https://docs.npmjs.com/) - Official docs & how-tos for all things **npm**
|
| 40 | * Note: you can also search docs locally with `npm help-search <query>`
|
| 41 | * [**Bug Tracker**](https://github.com/npm/cli/issues) - Search or submit bugs against the CLI
|
| 42 | * [**Roadmap**](https://github.com/orgs/github/projects/4247/views/1?filterQuery=npm) - Track & follow along with our public roadmap
|
| 43 | * [**Community Feedback and Discussions**](https://github.com/orgs/community/discussions/categories/npm) - Contribute ideas & discussion around the npm registry, website & CLI
|
| 44 | * [**RFCs**](https://github.com/npm/rfcs) - Contribute ideas & specifications for the API/design of the npm CLI
|
| 45 | * [**Service Status**](https://status.npmjs.org/) - Monitor the current status & see incident reports for the website & registry
|
| 46 | * [**Project Status**](https://npm.github.io/statusboard/) - See the health of all our maintained OSS projects in one view
|
| 47 | * [**Events Calendar**](https://calendar.google.com/calendar/u/0/embed?src=npmjs.com_oonluqt8oftrt0vmgrfbg6q6go@group.calendar.google.com) - Keep track of our Open RFC calls, releases, meetups, conferences & more
|
| 48 | * [**Support**](https://www.npmjs.com/support) - Experiencing problems with the **npm** [website](https://npmjs.com) or [registry](https://registry.npmjs.org)? File a ticket [here](https://www.npmjs.com/support)
|
| 49 |
|
| 50 | ### Acknowledgments
|
| 51 |
|
| 52 | * `npm` is configured to use the **npm Public Registry** at [https://registry.npmjs.org](https://registry.npmjs.org) by default; Usage of this registry is subject to **Terms of Use** available at [https://npmjs.com/policies/terms](https://npmjs.com/policies/terms)
|
| 53 | * You can configure `npm` to use any other compatible registry you prefer. You can read more about configuring third-party registries [here](https://docs.npmjs.com/cli/v7/using-npm/registry)
|
| 54 |
|
| 55 | ### FAQ on Branding
|
| 56 |
|
| 57 | #### Is it "npm" or "NPM" or "Npm"?
|
| 58 |
|
| 59 | **`npm`** should never be capitalized unless it is being displayed in a location that is customarily all-capitals (ex. titles on `man` pages).
|
| 60 |
|
| 61 | #### Is "npm" an acronym for "Node Package Manager"?
|
| 62 |
|
| 63 | Contrary to popular belief, **`npm`** **is not** in fact an acronym for "Node Package Manager"; It is a recursive bacronymic abbreviation for **"npm is not an acronym"** (if the project was named "ninaa", then it would be an acronym). The precursor to **`npm`** was actually a bash utility named **"pm"**, which was the shortform name of **"pkgmakeinst"** - a bash function that installed various things on various platforms. If **`npm`** were to ever have been considered an acronym, it would be as "node pm" or, potentially "new pm".
|