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…
NAME npm-profile – Change settings on your registry profile Synopsis npm profile get[–json | –parseable][<property>] npm profile set[–json | –parseable]<property><value> npm profile set password npm profile enable – 2fa [auth – and-writes | auth – only] npm profile disable – 2fa Description Change your profile information on the registry. This not be available if you’re…
NAME npm-prefix – Display prefix Synopsis npm prefix [-g] Description Print the local prefix to standard out. This is the closest parent directory to contain a package.json file or node_modules directory, unless -g is also specified. If -g is specified, this will be the value of the global prefix. See npm help config for more…
NAME npm-ping – Ping npm registry Synopsis npm ping [–registry <registry>] Description Ping the configured or given npm registry and verify authentication. If it works it will output something like: Ping success: {*Details about registry*} otherwise you will get: Ping error: {*Detail about error} See Also • npm help config • npm help npmrc Index
NAME npm-pack – Create a tarball from a package Synopsis npm pack[[<@scope> / ]<pkg>…][–dry – run] Description For anything that’s installable (that is, a package folder, tarball, tarball url, name@tag, name [at] version, name, or scoped name), this command will fetch it to the cache, and then copy the tarball to the current working directory…
NAME npm-owner – Manage package owners Synopsis npm owner add<user>[<@scope> / ]<pkg> npm owner rm<user>[<@scope> / ]<pkg> npm owner ls[<@scope> / ]<pkg> aliases : author Description Manage ownership of published packages. • ls: List all the users who have access to modify a package and push new versions. Handy when you need to know who…
NAME npm-outdated – Check for outdated packages Synopsis npm outdated[[<@scope> / ]<pkg>…] Description This command will check the registry to see if any (or, specific) installed packages are currently outdated. In the output: • wanted is the maximum version of the package that satisfies the semver range specified in package.json. If there’s no available semver…
NAME npm-org – Manage orgs Synopsis npm org set<orgname><username>[developer | admin | owner] npm org rm<orgname><username> npm org ls<orgname>[<username>] Example Add a new developer to an org: $ npm org set my-org @mx-smith Add a new admin to an org (or change a developer to an admin): $ npm org set my-org @mx-santos admin Remove…
NAME npm-ls – List installed packages Synopsis npm ls[[<@scope> / ]<pkg>…] aliases : list, la, ll Description This command will print to stdout all the versions of packages that are installed, as well as their dependencies, in a tree-structure. Positional arguments are name [at] version-range identifiers, which will limit the results to only the paths…
NAME npm-logout – Log out of the registry Synopsis npm logout[–registry = <url>][–scope = <@scope>] Description When logged into a registry that supports token-based authentication, tell the server to end this token’s session. This will invalidate the token everywhere you’re using it, not just for the current environment. When logged into a legacy registry that…
NAME npm-link – Symlink a package folder Synopsis npm link(in package dir) npm link[<@scope> / ]<pkg>[@<version>] alias : npm ln Description Package linking is a two-step process. First, npm link in a package folder will create a symlink in the global folder {prefix}/lib/node_modules/<package> that links to the package where the npm link command was executed….