The Linux Manuals (man pages) document is an important part of Linux documents. Linux Manuals are organized as several sections. Each section has a group of commands for a specific area in Linux usage, administration or development.
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…
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. •…