npm-logout – Log out of the registry Synopsisnpm logout [–registry=<url>] [–scope=<@scope>]DescriptionWhen 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 uses username and password authentication, this…
npm-link – Symlink a package folder Synopsisnpm link (in package dir) npm link [<@scope>/]<pkg>[@<version>] alias: npm lnDescriptionPackage 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. It will also link any…
npm-install – Install a package Synopsisnpm 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> npm install <tarball file> npm install <tarball url> npm install <folder> aliases: npm i, npm add common options:…
npm Synopsisnpm 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: npm it common options: [–save|–save-dev|–save-optional] [–save-exact] [–dry-run]DescriptionThis command runs an npm install followed immediately by an npm test. It takes exactly…
npm Synopsisnpm install-ci-test alias: npm citDescriptionThis command runs an npm ci followed immediately by an npm test. See Also• npm help ci • npm help test
npm-init – create a package.json file Synopsisnpm init [–force|-f|–yes|-y|–scope] npm init <@scope> (same as `npx <@scope>/create`) npm init [<@scope>/]<name> (same as `npx [<@scope>/]create-<name>`)ExamplesCreate 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 create-esm https://npm.im/create-esm: $ mkdir my-esm-lib && cd my-esm-lib $ npm init esm –yes Generate…
npm-hook – Manage registry hooks Synopsisnpm hook ls [pkg] npm hook add <entity> <url> <secret> npm hook update <id> <url> [secret] npm hook rm <id>ExampleAdd 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…
npm-help – Get help on npm Synopsisnpm help <term> [<terms..>]DescriptionIf 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 run help on that…
npm-help-search – Search npm help documentation Synopsisnpm help-search <text>DescriptionThis 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 known help topic, then…
npm-fund – Retrieve funding information Synopsis npm fund [<pkg>]DescriptionThis 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 to visit. If…
npm-explore – Browse an installed package Synopsisnpm explore <pkg> [ — <command>]DescriptionSpawn 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 folder: npm explore some-dependency…
npm-edit – Edit an installed package Synopsisnpm edit <pkg>[/<subpkg>…]DescriptionSelects 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 up any changes in…
npm-doctor – Check your environments Synopsisnpm doctorDescriptionnpm 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 executable by npm. •…
npm-docs – Docs for a package in a web browser maybe Synopsisnpm docs [<pkgname> [<pkgname> …]] npm docs . npm home [<pkgname> [<pkgname> …]] npm home .DescriptionThis 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…
npm-dist-tag – Modify package distribution tags Synopsisnpm dist-tag add <pkg>@<version> [<tag>] npm dist-tag rm <pkg> <tag> npm dist-tag ls [<pkg>] aliases: dist-tagsDescriptionAdd, remove, and enumerate distribution tags on a package: • add: Tags the specified version of the package with the specified tag, or the –tag config if not specified. If you have two-factor authentication…
npm-deprecate – Deprecate a version of a package Synopsisnpm deprecate <pkg>[@<version>] <message>DescriptionThis 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: npm deprecate my-thing@"< 0.2.3"…
npm-dedupe – Reduce duplication Synopsisnpm dedupe npm ddp aliases: find-dupes, ddpDescriptionSearches 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 on c@1.0.x | `–…
npm-config – Manage the npm configuration files Synopsisnpm 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: cDescriptionnpm gets its config settings from the command line, environment variables, npmrc files, and in some cases,…
npm-completion – Tab Completion for npm Synopsissource <(npm completion)DescriptionEnables 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 the output of npm…
npm-ci – Install a project with a clean slate Synopsisnpm ciExampleMake 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 Travis to build using…