npm-shrinkwrap – Lock down dependency versions for publication Synopsisnpm shrinkwrapDescriptionThis 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 purpose of package locks…
npm-search – Search for packages Synopsisnpm search [-l|–long] [–json] [–parseable] [–no-description] [search terms …] aliases: s, se, findDescriptionSearch 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 matches in the…
npm-run-script – Run arbitrary package scripts Synopsisnpm run-script <command> [–silent] [– <args>…] alias: npm runDescriptionThis 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 well. When the…
npm-root – Display npm root Synopsisnpm root [-g]DescriptionPrint 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
npm-rm — Remove a package Synopsisnpm rm <name> npm uninstall <name>DescriptionThis 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
npm-restart – Restart a package Synopsisnpm restart [– <args>]DescriptionThis 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 NoteNote that the "restart" script…
npm-repo – Open package repository page in the browser Synopsisnpm repo [<pkg>]DescriptionThis 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 folder and use the…
npm-rebuild – Rebuild a package Synopsisnpm rebuild [[<@scope>/<name>]…] alias: npm rbDescriptionThis 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 • npm help install
npm-publish – Publish a package Synopsisnpm publish [<tarball>|<folder>] [–tag <tag>] [–access <public|restricted>] [–otp otpcode] [–dry-run] Publishes ‘.’ if no argument supplied Sets tag ‘latest’ if no –tag specifiedDescriptionPublishes a package to the registry so that it can be installed by name. All files in the package directory are included if no local .gitignore or .npmignore…
npm-prune – Remove extraneous packages Synopsisnpm prune [[<@scope>/]<pkg>…] [–production] [–dry-run] [–json]DescriptionThis 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 specified or the NODE_ENV…
npm-profile – Change settings on your registry profile Synopsisnpm 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-2faDescriptionChange your profile information on the registry. This not be available if you’re using a non-npmjs registry. • npm profile get [<property>]: Display all of the…
npm-prefix – Display prefix Synopsisnpm prefix [-g]DescriptionPrint 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 detail. See Also• npm…
npm-ping – Ping npm registry Synopsisnpm ping [–registry <registry>]DescriptionPing 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
npm-pack – Create a tarball from a package Synopsisnpm pack [[<@scope>/]<pkg>…] [–dry-run]DescriptionFor 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 as <name>-<version>.tgz, and then write the…
npm-owner – Manage package owners Synopsisnpm owner add <user> [<@scope>/]<pkg> npm owner rm <user> [<@scope>/]<pkg> npm owner ls [<@scope>/]<pkg> aliases: authorDescriptionManage 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 to bug for help. • add:…
npm-outdated – Check for outdated packages Synopsisnpm outdated [[<@scope>/]<pkg> …]DescriptionThis 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 range (i.e. you’re running…
npm-org – Manage orgs Synopsisnpm org set <orgname> <username> [developer | admin | owner] npm org rm <orgname> <username> npm org ls <orgname> [<username>]ExampleAdd 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…
npm-ls – List installed packages Synopsisnpm ls [[<@scope>/]<pkg> …] aliases: list, la, llDescriptionThis 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 to the packages named. Note…
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…