npm/cli


the package manager for JavaScript

https://npm.community

License: Other

Language: JavaScript

Keywords: javascript, nodejs, npm, package-manager, tools


npm(1) -- a JavaScript package manager

Build Status

SYNOPSIS

This is just enough info to get you up and running.

Much more info will be available via npm help once it's installed.

IMPORTANT

You need node v6 or higher to run this program.

To install an old and unsupported version of npm that works on node v5 and prior, clone the git repo and dig through the old tags and branches.

npm is configured to use npm, Inc.'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://www.npmjs.com/policies/terms.

You can configure npm to use any compatible registry you like, and even run your own registry. Check out the doc on registries.

Super Easy Install

npm is bundled with node.

Windows Computers

Get the MSI. npm is in it.

Apple Macintosh Computers

Get the pkg. npm is in it.

Other Sorts of Unices

Run make install. npm will be installed with node.

If you want a more fancy pants install (a different version, customized paths, etc.) then read on.

Fancy Install (Unix)

There's a pretty robust install script at https://www.npmjs.com/install.sh. You can download that and run it.

Here's an example using curl:

curl -L https://www.npmjs.com/install.sh | sh

Slightly Fancier

You can set any npm configuration params with that script:

npm_config_prefix=/some/path sh install.sh

Or, you can run it in uber-debuggery mode:

npm_debug=1 sh install.sh

Even Fancier

Get the code with git. Use make to build the docs and do other stuff. If you plan on hacking on npm, make link is your friend.

If you've got the npm source code, you can also semi-permanently set arbitrary config keys using the ./configure --key=val ..., and then run npm commands by doing node bin/npm-cli.js <command> <args>. (This is helpful for testing, or running stuff without actually installing npm itself.)

Windows Install or Upgrade

Many improvements for Windows users have been made in npm 3 - you will have a better experience if you run a recent version of npm. To upgrade, either use Microsoft's upgrade tool, download a new version of Node, or follow the Windows upgrade instructions in the Installing/upgrading npm post.

If that's not fancy enough for you, then you can fetch the code with git, and mess with it directly.

Installing on Cygwin

No.

Uninstalling

So sad to see you go.

sudo npm uninstall npm -g

Or, if that fails,

sudo make uninstall

More Severe Uninstalling

Usually, the above instructions are sufficient. That will remove npm, but leave behind anything you've installed.

If you would like to remove all the packages that you have installed, then you can use the npm ls command to find them, and then npm rm to remove them.

To remove cruft left behind by npm 0.x, you can use the included clean-old.sh script file. You can run it conveniently like this:

npm explore npm -g -- sh scripts/clean-old.sh

npm uses two configuration files, one for per-user configs, and another for global (every-user) configs. You can view them by doing:

npm config get userconfig   # defaults to ~/.npmrc
npm config get globalconfig # defaults to /usr/local/etc/npmrc

Uninstalling npm does not remove configuration files by default. You must remove them yourself manually if you want them gone. Note that this means that future npm installs will not remember the settings that you have chosen.

More Docs

Check out the docs.

You can use the npm help command to read any of them.

If you're a developer, and you want to use npm to publish your program, you should read this.

BUGS

When you find issues, please report them:

Be sure to include all of the output from the npm command that didn't work as expected. The npm-debug.log file is also helpful to provide.

You can also find npm people in #npm on https://package.community/ or on Twitter. Whoever responds will no doubt tell you to put the output in a gist or email.

SEE ALSO

  • npm(1)
  • npm-help(1)
  • npm-index(7)

Project Statistics

Sourcerank 21
Repository Size 43.7 MB
Stars 2,490
Forks 588
Watchers 121
Open issues 253
Dependencies 683
Contributors 482
Tags 854
Created
Last updated
Last pushed

Top Contributors See all

isaacs Rebecca Turner Forrest L Norvell Kat Marchán Daijiro Wachi Robert Kowalski Domenic Denicola Sam Mikes Kenan Yildirim Tim Kevin Oxley Martin Cooper Luke Arduini Evan Meagher Bryan English Kyle E. Mitchell Dean Landolt Lars Willighagen Chris Meyers Dylan Greene Mike Sherov

Packages Referencing this Repo

npm
a package manager for JavaScript
Latest release 6.13.2 - Updated - 2.49K stars
unip
Universal plugin boilerplate with svelte, create plugin/component for use in pure JavaScript, VUE...
Latest release 0.0.1-alpha-7 - Updated - 2.49K stars
@salomvary/npm
a package manager for JavaScript
Latest release 6.10.1-salomvary1 - Published - 2.49K stars
@sekwiatkowski/flowscript
A functional programming library for JavaScript/TypeScript designed to implement workflows
Latest release 0.17.1 - Published - 2.49K stars
@sekwiatkowski/flow-script
A functional programming library for JavaScript/TypeScript designed to implement workflows
Latest release 0.17.1 - Published - 2.49K stars
js-computation
A pragmatic functional programming library for JavaScript/TypeScript
Latest release 0.17.1 - Published - 2.49K stars
yasgsb
Yet another simple game server boilerplate
Latest release 0.9.1 - Updated - 2.49K stars
datetimemodule
a package manager for JavaScript
Latest release 0.0.1 - Published - 2.49K stars
npm-prog
a package manager for JavaScript
Latest release 6.11.3 - Published - 2.49K stars
idb-test-draszek
## Project setup ``` npm install ```
Latest release 0.2.0 - Updated - 2.49K stars
isobjectmatchingmodel
Function to compare a model and an object. If object has all nested properties of model, it retur...
Latest release 1.0.1 - Updated - 2.49K stars
presentation-generator
A simple app that generates presentations based on a folder structure.
Latest release 1.0.17 - Updated - 2.49K stars
transformative
A pragmatic functional programming library for JavaScript/TypeScript
Latest release 0.17.1 - Published - 2.49K stars
shaocongwang
a package manager for JavaScript
Latest release 6.9.0 - Published - 2.49K stars
react-virtualized-cssgrid
React Virtualization with CSS Grid
Latest release 0.0.2 - Updated - 2.49K stars
@kuinox/testpackagethatnooneshoulduse
a package manager for JavaScript
Latest release 6.42.5-ci - Published - 2.49K stars
dsa-bulma
A Bulma theme built for smashing capitalism
Latest release 0.1.3 - Updated - 2.49K stars
@kuinox/testpackagethatnooneshoulduseever
a package manager for JavaScript
Latest release 6.42.6-ci - Published - 2.49K stars
fragnostic-module-template
the package manager for JavaScript
Latest release 0.1.0-SNAPSHOT - Published - 2.49K stars
angular4-hourinputlengthrestricted-datetimepicker
The input text box for hour input has the length restricted to two for custom use in the project
Latest release 1.1.4 - Published - 2.49K stars

Recent Tags See all

v6.13.2 December 03, 2019
v6.13.1 November 18, 2019
v6.13.0 November 05, 2019
v6.12.1 October 29, 2019
v6.12.0 October 08, 2019
v6.12.0-next.0 September 26, 2019
v6.11.3 September 03, 2019
v6.11.2 August 22, 2019
v6.11.1 August 21, 2019
v6.11.0 August 20, 2019
v6.10.3 August 06, 2019
v6.10.2 July 23, 2019
v6.10.2-next.3 July 22, 2019
v6.10.2-next.2 July 21, 2019
v6.10.2-next.1 July 17, 2019

Interesting Forks See all

abbichristina02/cli
a package manager for JavaScript, report bugs and get support at:
JavaScript - Other - Updated - 1 stars

Something wrong with this page? Make a suggestion

Last synced: 2019-06-03 19:15:23 UTC

Login to resync this repository