Section 1: user commands and tools
NAME npm-uninstall – Remove a package Synopsis npm uninstall[<@scope> / ]<pkg>[@<version>]…[-S | –save | -D | –save – dev | -O | –save – optional | –no – save] aliases : remove, rm, r, un, unlink Description This uninstalls a package, completely removing everything npm installed on its behalf. Example: npm uninstall sax In global…
NAME npm-token – Manage your authentication tokens Synopsis npm token list[–json | –parseable] npm token create[–read – only][–cidr = 1.1.1.1 / 24, 2.2.2.2 / 16] npm token revoke<id | token> Description This lets you list, create and revoke authentication tokens. • npm token list: Shows a table of all active authentication tokens. You can request…
NAME npm-test – Test a package Synopsis npm test [– <args>] aliases: t, tst Description This runs a package’s "test" script, if one was provided. See Also • npm help run-script • npm help scripts • npm help start • npm help restart • npm help stop Index
NAME npm-team – Manage organization teams and team memberships Synopsis npm team create <scope:team> npm team destroy <scope:team> npm team add <scope:team> <user> npm team rm <scope:team> <user> npm team ls <scope>|<scope:team> npm team edit <scope:team> Description Used to manage teams in organizations, and change team memberships. Does not handle permissions for packages. Teams must…
NAME npm-tag – Tag a published version SYNOPSIS [DEPRECATED] npm tag<name> @<version>[<tag>] See `dist – tag` DESCRIPTION THIS COMMAND IS DEPRECATED. See npm help dist-tag for details. Tags the specified version of the package with the specified tag, or the –tag config if not specified. A tag can be used when installing packages as a…
NAME npm-submodule — Add a package as a git submodule SYNOPSIS npm submodule <pkg> DESCRIPTION If the specified package has a git repository url in its package.json description, then this command will add it as a git submodule at node_modules/<pkg name>. This is a convenience only. From then on, it’s up to you to manage…
NAME npm-stop – Stop a package Synopsis npm stop [– <args>] Description This runs a package’s "stop" script, if one was provided. See Also • npm help run-script • npm help scripts • npm help test • npm help start • npm help restart Index
NAME npm-start – Start a package Synopsis npm start [– <args>] Description This runs an arbitrary command specified in the package’s "start" property of its "scripts" object. If no "start" property is specified on the "scripts" object, it will run node server.js. As of npm [at] 2.0.0 https://blog.npmjs.org/post/98131109725/npm-2-0-0, you can use custom arguments when executing…
NAME npm-stars – View packages marked as favorites Synopsis npm stars [<user>] Description If you have starred a lot of neat things and want to find them again quickly this command lets you do just that. You may also want to see your friend’s favorite packages, in this case you will most certainly enjoy this…
NAME npm-star – Mark your favorite packages Synopsis npm star[<pkg>…] npm unstar[<pkg>…] Description "Starring" a package means that you have some interest in it. It’s a vaguely positive way to show that you care. "Unstarring" is the same thing, but in reverse. It’s a boolean thing. Starring repeatedly has no additional effect. See Also •…
NAME npm-shrinkwrap – Lock down dependency versions for publication Synopsis npm shrinkwrap Description This command repurposes package-lock.json into a publishable npm-shrinkwrap.json or simply creates a new one. The file created and updated by this command will then take precedence over any other existing or future package-lock.json files. For a detailed explanation of the design and…
NAME npm-search – Search for packages Synopsis npm search[-l | –long][–json][–parseable][–no – description][search terms…] aliases : s, se, find Description Search the registry for packages matching the search terms. npm search performs a linear, incremental, lexically-ordered search through package metadata for all files in the registry. If color is enabled, it will further highlight the…
NAME npm-run-script – Run arbitrary package scripts Synopsis npm run – script<command>[–silent][–<args>…] alias : npm run Description This runs an arbitrary command from a package’s "scripts" object. If no "command" is provided, it will list the available scripts. run[-script] is used by the test, start, restart, and stop commands, but can be called directly, as…
NAME npm-root – Display npm root Synopsis npm root [-g] Description Print the effective node_modules folder to standard out. See Also • npm help prefix • npm help bin • npm help folders • npm help config • npm help npmrc Index
NAME npm-rm — Remove a package SYNOPSIS npm rm <name> npm uninstall <name> DESCRIPTION This uninstalls a package, completely removing everything npm installed on its behalf. SEE ALSO • npm help prune • npm help install • npm help folders • npm help config • npm help config • npm help npmrc Index
NAME npm-restart – Restart a package Synopsis npm restart [– <args>] Description This restarts a package. This runs a package’s "stop", "restart", and "start" scripts, and associated pre- and post- scripts, in the order given below: 1. prerestart 2. prestop 3. stop 4. poststop 5. restart 6. prestart 7. start 8. poststart 9. postrestart Note…
NAME npm-repo – Open package repository page in the browser Synopsis npm repo [<pkg>] Description This command tries to guess at the likely location of a package’s repository URL, and then tries to open it using the –browser config param. If no package name is provided, it will search for a package.json in the current…
NAME npm-rebuild – Rebuild a package Synopsis npm rebuild[[<@scope> / <name>]…] alias : npm rb Description This command runs the npm build command on the matched folders. This is useful when you install a new version of node, and must recompile all your C++ addons with the new binary. See Also • npm help build…
NAME npm-publish – Publish a package Synopsis npm publish[<tarball> | <folder>][–tag<tag>][–access<public | restricted>][–otp otpcode][–dry – run] Publishes ‘.’ if no argument supplied Sets tag ‘latest’ if no– tag specified Description Publishes a package to the registry so that it can be installed by name. All files in the package directory are included if no local…
NAME npm-prune – Remove extraneous packages Synopsis npm prune[[<@scope> / ]<pkg>…][–production][–dry – run][–json] Description This command removes "extraneous" packages. If a package name is provided, then only packages matching one of the supplied names are removed. Extraneous packages are packages that are not listed on the parent package’s dependencies list. If the –production flag is…