NAME npm-install – Install a package Synopsis npm install(with no args, in package dir) npm install[<@scope> / ]<name> npm install[<@scope> / ]<name> @<tag> npm install[<@scope> / ]<name> @<version> npm install[<@scope> / ]<name> @<version range> npm install<alias> @npm : <name> npm install<git – host> : <git – user> / <repo – name> npm install<git repo url>…
NAME npm Synopsis npm install – test(with no args, in package dir) npm install – test[<@scope> / ]<name> npm install – test[<@scope> / ]<name> @<tag> npm install – test[<@scope> / ]<name> @<version> npm install – test[<@scope> / ]<name> @<version range> npm install – test<tarball file> npm install – test<tarball url> npm install – test<folder> alias…
NAME npm Synopsis npm install-ci-test alias: npm cit Description This command runs an npm ci followed immediately by an npm test. See Also • npm help ci • npm help test Index
NAME npm-init – create a package.json file Synopsis npm init[–force | -f | –yes | -y | –scope] npm init<@scope>(same as `npx<@scope> / create`) npm init[<@scope> / ]<name>(same as `npx[<@scope> / ] create – <name>`) Examples Create a new React-based project using create-react-app https://npm.im/create-react-app: $ npm init react-app ./my-react-app Create a new esm-compatible package using…
NAME npm-hook – Manage registry hooks Synopsis npm hook ls[pkg] npm hook add<entity><url><secret> npm hook update<id><url>[secret] npm hook rm<id> Example Add a hook to watch a package for changes: $ npm hook add lodash https://example.com/ my-shared-secret Add a hook to watch packages belonging to the user substack: $ npm hook add ~substack https://example.com/ my-shared-secret Add…
NAME npm-help – Get help on npm Synopsis npm help <term> [<terms..>] Description If supplied a topic, then show the appropriate documentation page. If the topic does not exist, or if multiple terms are provided, then run the help-search command to find a match. Note that, if help-search finds a single subject, then it will…
NAME npm-help-search – Search npm help documentation Synopsis npm help-search <text> Description This command will search the npm markdown documentation files for the terms provided, and then list the results, sorted by relevance. If only one result is found, then it will show that help topic. If the argument to npm help is not a…
NAME npm-fund – Retrieve funding information Synopsis npm fund [<pkg>] Description This command retrieves information on how to fund the dependencies of a given project. If no package name is provided, it will list all dependencies that are looking for funding in a tree-structure in which are listed the type of funding and the url…
NAME npm-explore – Browse an installed package Synopsis npm explore <pkg> [ — <command>] Description Spawn a subshell in the directory of the installed package specified. If a command is specified, then it is run in the subshell, which then immediately terminates. This is particularly handy in the case of git submodules in the node_modules…
NAME npm-edit – Edit an installed package Synopsis npm edit <pkg>[/<subpkg>…] Description Selects a (sub)dependency in the current working directory and opens the package folder in the default editor (or whatever you’ve configured as the npm editor config — see npm-config npm-config.) After it has been edited, the package is rebuilt so as to pick…
NAME npm-doctor – Check your environments Synopsis npm doctor Description npm doctor runs a set of checks to ensure that your npm installation has what it needs to manage your JavaScript packages. npm is mostly a standalone tool, but it does have some basic requirements that must be met: • Node.js and git must be…
NAME npm-docs – Docs for a package in a web browser maybe Synopsis npm docs[<pkgname>[<pkgname>…]] npm docs.npm home[<pkgname>[<pkgname>…]] npm home. Description This command tries to guess at the likely location of a package’s documentation URL, and then tries to open it using the –browser config param. You can pass multiple package names at once. If…
NAME npm-dist-tag – Modify package distribution tags Synopsis npm dist – tag add<pkg> @<version>[<tag>] npm dist – tag rm<pkg><tag> npm dist – tag ls[<pkg>] aliases : dist – tags Description Add, remove, and enumerate distribution tags on a package: • add: Tags the specified version of the package with the specified tag, or the –tag…
NAME npm-deprecate – Deprecate a version of a package Synopsis npm deprecate <pkg>[@<version>] <message> Description This command will update the npm registry entry for a package, providing a deprecation warning to all who attempt to install it. It works on version ranges https://semver.npmjs.com/ as well as specific versions, so you can do something like this:…
NAME npm-dedupe – Reduce duplication Synopsis npm dedupe npm ddp aliases: find-dupes, ddp Description Searches the local package tree and attempts to simplify the overall structure by moving dependencies further up the tree, where they can be more effectively shared by multiple dependent packages. For example, consider this dependency graph: a + –b < –depends…
NAME npm-config – Manage the npm configuration files Synopsis npm config set<key><value>[-g | –global] npm config get<key> npm config delete<key> npm config list[-l][–json] npm config edit npm get<key> npm set<key><value>[-g | –global] aliases : c Description npm gets its config settings from the command line, environment variables, npmrc files, and in some cases, the package.json…
NAME npm-completion – Tab Completion for npm Synopsis source <(npm completion) Description Enables tab-completion in all npm commands. The synopsis above loads the completions into your current shell. Adding it to your ~/.bashrc or ~/.zshrc will make the completions available everywhere: npm completion >> ~/.bashrc npm completion >> ~/.zshrc You may of course also pipe…
NAME npm-ci – Install a project with a clean slate Synopsis npm ci Example Make sure you have a package-lock and an up-to-date install: $ cd ./my/npm/project $ npm install added 154 packages in 10s $ ls | grep package-lock Run npm ci in that project $ npm ci added 154 packages in 5s Configure…
NAME npm-cache – Manipulates packages cache Synopsis npm cache add <tarball file> npm cache add <folder> npm cache add <tarball url> npm cache add <name>@<version> npm cache clean [<path>] aliases: npm cache clear, npm cache rm npm cache verify Description Used to add, list, or clean the npm cache folder. • add: Add the specified…
NAME npm-bundle – REMOVED Description The npm bundle command has been removed in 1.0, for the simple reason that it is no longer necessary, as the default behavior is now to install packages into the local space. Just use npm install now to do what npm bundle used to do. See Also • npm help…