npm

https://docs.npmjs.com/
Admin
npm is the default package manager for Node.js, used for installing, sharing, and managing software...
Tokens:225,210
Snippets:2,331
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### package.json start script example

Source: https://docs.npmjs.com/cli/v12/commands/npm-start

Example of a package.json file defining a 'start' script that runs node foo.js.

```json
{
  "scripts": {
    "start": "node foo.js"
  }
}
```

--------------------------------

### npm install folder examples

Source: https://docs.npmjs.com/cli/v12/commands/npm-install

Examples of installing a package from a folder. The first uses --install-links to install the content of a directory like a package from the registry instead of creating a link. The second installs a sub-package from a local folder.

```bash
npm install ../../other-package --install-links
npm install ./sub-package
```

--------------------------------

### Install from folder with --install-links

Source: https://docs.npmjs.com/cli/install

Examples for installing a package from a folder. The first uses --install-links to install the content of a directory like a package from the registry, while the second installs a sub-package.

```bash
npm install ../../other-package --install-links
npm install ./sub-package

```

--------------------------------

### Install from tarball URL

Source: https://docs.npmjs.com/cli/install

Example for installing a package from a tarball URL. The argument must start with http:// or https://.

```bash
npm install https://github.com/indexzero/forever/tarball/v0.5.6

```

--------------------------------

### Example response for all verified signatures

Source: https://docs.npmjs.com/verifying-registry-signatures

Example response when all installed versions have valid registry signatures.

```text
audited 1640 packages in 2s

1640 have verified registry signatures
```

--------------------------------

### Install from tarball file

Source: https://docs.npmjs.com/cli/install

Example for installing a package from a local tarball file. The file must use .tar, .tar.gz, or .tgz extension and contain a package.json with name and version.

```bash
npm install ./package.tgz

```

--------------------------------

### Install package with dist-tag using npm install example-package@beta

Source: https://docs.npmjs.com/downloading-and-installing-packages-locally

Installs a package using a specific dist-tag instead of the default latest. This example uses the beta tag.

```bash
npm install example-package@beta
```

--------------------------------

### npm approve-scripts examples

Source: https://docs.npmjs.com/cli/v12/commands/npm-approve-scripts

Examples of approving install scripts: all packages, specific packages, name-only approval, and previewing pending packages.

```bash
# Approve all currently-installed install scripts after reviewing them
npm approve-scripts --all


# Approve specific packages, pinned to their installed version
npm approve-scripts canvas sharp


# Approve name-only (any version of this package is allowed)
npm approve-scripts --no-allow-scripts-pin canvas


# Preview which packages still need review
npm approve-scripts --allow-scripts-pending
```

--------------------------------

### npm install tarball file example

Source: https://docs.npmjs.com/cli/v12/commands/npm-install

Installs a package from a tarball file on the filesystem. The tarball must use .tar, .tar.gz, or .tgz extension, contain a package.json with name and version, and have its contents in a subfolder (usually package/).

```bash
npm install ./package.tgz
```

--------------------------------

### Prepare project with npm install

Source: https://docs.npmjs.com/cli/v12/commands/npm-ci

Navigate to a project and run npm install to ensure a package-lock file exists and the install is up-to-date before using npm ci.

```bash
$ cd ./my/npm/project
$ npm install
added 154 packages in 10s
$ ls | grep package-lock

```

--------------------------------

### Install package with tag

Source: https://docs.npmjs.com/cli/dist-tag

Shows how to install a package using a distribution tag as a reference to a version.

```bash
npm install <name>@<tag>

```

--------------------------------

### npm install command-line flags

Source: https://docs.npmjs.com/cli/v12/using-npm/config

Common command-line flag examples for npm install. --prefix runs npm commands in a different directory, --global installs packages globally (shorthand -g), and --save-dev saves to devDependencies (shorthand -D).

```bash
npm install --prefix /path/to/dir
```

```bash
npm install --global
```

```bash
npm install --save-dev
```

--------------------------------

### npm profile get example output

Source: https://docs.npmjs.com/cli/profile

Example output of `npm profile get` when no property is specified, displaying all profile properties. The output includes the user's name, email with verification status, two-factor authentication mode, fullname, homepage, github, and creation/update timestamps.

```text
name: example
email: e@example.com (verified)
two-factor auth: auth-and-writes
fullname: Example User
homepage:
github:
created: 2015-02-26T01:38:35.892Z
updated: 2017-10-02T21:29:45.922Z
```

--------------------------------

### npm start synopsis

Source: https://docs.npmjs.com/cli/v12/commands/npm-start

Shows the basic command syntax for npm start, including the optional -- <args> to pass arguments to the script.

```bash
npm start [-- <args>]
```

--------------------------------

### npm start command and output

Source: https://docs.npmjs.com/cli/v12/commands/npm-start

Shows the npm start command and its expected output, including the script execution and placeholder for foo.js output.

```bash
npm start


> npm@x.x.x start
> node foo.js


(foo.js output would be here)
```

--------------------------------

### npm explain glob example output

Source: https://docs.npmjs.com/cli/v12/commands/npm-explain

Example output of running 'npm explain glob' within npm's source tree. Shows the chain of dependencies causing the glob package to be installed, including dev dependencies and nested versions.

```text
glob@7.1.6
node_modules/glob
  glob@"^7.1.4" from the root project


glob@7.1.1 dev
node_modules/tacks/node_modules/glob
  glob@"^7.0.5" from rimraf@2.6.2
  node_modules/tacks/node_modules/rimraf
    rimraf@"^2.6.2" from tacks@1.3.0
    node_modules/tacks
      dev tacks@"^1.3.0" from the root project
```

--------------------------------

### Run the installed package

Source: https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally

Run the installed package to confirm it works.

```bash
ncu -g
```

--------------------------------

### Basic Dockerfile without private package support

Source: https://docs.npmjs.com/docker-and-private-modules

A basic Dockerfile that copies package.json, installs dependencies, copies source files, and runs the start command. This example does not support private npm packages because it lacks build secrets.

```dockerfile
FROM node


COPY package.json package.json
RUN npm install


# Add your source files
COPY . .
CMD npm start

```

--------------------------------

### npm install synopsis and aliases

Source: https://docs.npmjs.com/cli/install

Shows the basic syntax of the npm install command and its aliases: add, i, in, ins, inst, insta, instal, isnt, isnta, isntal, isntall.

```bash
npm install [<package-spec> ...]


aliases: add, i, in, ins, inst, insta, instal, isnt, isnta, isntal, isntall

```

--------------------------------

### Default install script

Source: https://docs.npmjs.com/cli/v12/configuring-npm/package-json

Default install script when a binding.gyp file exists and no install or preinstall script is defined.

```json
"scripts":{"install": "node-gyp rebuild"}
```

--------------------------------

### Install package globally for testing

Source: https://docs.npmjs.com/cli/v12/using-npm/developers

Run this in the root of your package to verify it installs correctly before publishing.

```bash
npm install . -g
```

--------------------------------

### Example workspace directory structure

Source: https://docs.npmjs.com/cli/v12/using-npm/workspaces

Example project structure with a root package.json and two workspaces, a and b, each containing their own package.json.

```text
.
+-- package.json
`-- packages
   +-- a
   |   `-- package.json
   `-- b
       `-- package.json

```

--------------------------------

### peerDependenciesMeta example

Source: https://docs.npmjs.com/cli/v12/configuring-npm/package-json

Example package.json showing how to mark a peer dependency as optional using the peerDependenciesMeta field. npm will not automatically install optional peer dependencies.

```json
{
  "name": "@npm/tea-latte",
  "version": "1.3.5",
  "peerDependencies": {
    "@npm/tea": "2.x",
    "@npm/soy-milk": "1.2"
  },
  "peerDependenciesMeta": {
    "@npm/soy-milk": {
      "optional": true
    }
  }
}
```

--------------------------------

### peerDependencies example

Source: https://docs.npmjs.com/cli/v12/configuring-npm/package-json

Example package.json using peerDependencies to express compatibility with a host package. This ensures the package can be installed alongside the specified major version of the host.

```json
{
  "name": "@npm/tea-latte",
  "version": "1.3.5",
  "peerDependencies": {
    "@npm/tea": "2.x"
  }
}
```

--------------------------------

### Example package.json with name, version, and author fields

Source: https://docs.npmjs.com/about-package-json-and-package-lock-json-files

Example package.json file showing the required name and version fields, plus an optional author field in the format 'Your Name <email@example.com> (https://example.com)'. The name must be lowercase without spaces, and the version must follow semantic versioning (x.x.x).

```json
{
  "name": "my-awesome-package",
  "version": "1.0.0",
  "author": "Your Name <email@example.com> (https://example.com)"
}
```

--------------------------------

### Generate npm-debug.log with npm install --timing or npm publish --timing

Source: https://docs.npmjs.com/generating-and-locating-npm-debug.log-files

Run either command to generate an npm-debug.log file. The install command is for installing packages, and the publish command is for publishing packages. The file is written to your .npm directory, usually found via `npm config get cache`.

```shell
npm install --timing
```

```shell
npm publish --timing
```

--------------------------------

### npm install with git URLs

Source: https://docs.npmjs.com/cli/install

Examples of installing packages from git URLs using various protocols and commit-ish or semver ranges. The GIT_SSH_COMMAND environment variable can be used to specify an SSH key.

```bash
npm install git+ssh://git@github.com:npm/cli.git#v1.0.27
npm install git+ssh://git@github.com:npm/cli#pull/273
npm install git+ssh://git@github.com:npm/cli#semver:^5.0
npm install git+https://isaacs@github.com/npm/cli.git
npm install git://github.com/npm/cli.git#v1.0.27
GIT_SSH_COMMAND='ssh -i ~/.ssh/custom_ident' npm install git+ssh://git@github.com:npm/cli.git
```

--------------------------------

### Install with preferred tag

Source: https://docs.npmjs.com/cli/dist-tag

Shows how to specify a preferred tagged version when installing dependencies.

```bash
npm install --tag <tag>

```

--------------------------------

### Example workspace project structure

Source: https://docs.npmjs.com/cli/v12/commands/npm-exec

Example project structure with configured workspaces. The root `package.json` defines the workspaces, and each package under `packages/` has its own `package.json`.

```text
.
+-- package.json
`-- packages
   +-- a
   |   `-- package.json
   +-- b
   |   `-- package.json
   `-- c
       `-- package.json
```

--------------------------------

### npm explore with command

Source: https://docs.npmjs.com/cli/v12/commands/npm-explore

Example of running a command in the installed package's directory. Useful for git submodules in the node_modules folder. The package is not automatically rebuilt afterwards, so use npm rebuild <pkg> if you make changes.

```bash
npm explore some-dependency -- git pull origin master
```

--------------------------------

### Example: Publish package with beta dist-tag

Source: https://docs.npmjs.com/adding-dist-tags-to-packages

Publishes the package with the 'beta' dist-tag.

```bash
npm publish --tag beta
```

--------------------------------

### Example output of npm prefix

Source: https://docs.npmjs.com/cli/v12/commands/npm-prefix

Example output of the npm prefix command showing the local prefix path.

```bash
npm prefix
/usr/local/projects/foo
```

--------------------------------

### npm install-scripts command examples

Source: https://docs.npmjs.com/cli/v12/commands/npm-install-scripts

Shows the main npm install-scripts subcommands: approve with --all or specific packages, deny, ls, and prune with --dry-run. The prune example previews stale allowScripts entries before removing them.

```bash
# Approve all currently-installed install scripts after reviewing them
npm install-scripts approve --all


# Approve specific packages, pinned to their installed version
npm install-scripts approve canvas sharp


# Deny a package so it stays blocked
npm install-scripts deny telemetry-pkg


# Preview which packages still need review
npm install-scripts ls


# Preview stale allowScripts entries, then remove them
npm install-scripts prune --dry-run
npm install-scripts prune
```

--------------------------------

### npm install with save flags

Source: https://docs.npmjs.com/cli/install

Shows various forms of npm install with different save flags: --save-dev, --save-optional, --save-exact, and --save-bundle. The first two examples install by name and GitHub repository, and the third uses a scoped package.

```bash
npm install sax
npm install githubname/reponame
npm install @myorg/privatepackage
npm install node-tap --save-dev
npm install dtrace-provider --save-optional
npm install readable-stream --save-exact
npm install ansi-regex --save-bundle
```

--------------------------------

### Default start script

Source: https://docs.npmjs.com/cli/v12/configuring-npm/package-json

Default start script when a server.js file exists in the package root.

```json
"scripts": {"start": "node server.js"}
```

--------------------------------

### Tilde dependency ~1.1.1

Source: https://docs.npmjs.com/cli/update

Tilde dependency example. Running npm update installs dep1@1.1.2 because ~1.1.1 is equivalent to >=1.1.1 <1.2.0.

```json
"dependencies": {
  "dep1": "~1.1.1"
}
```

--------------------------------

### npm install --prefer-dedupe

Source: https://docs.npmjs.com/cli/v12/commands/npm-dedupe

Install with --prefer-dedupe to prefer deduplication over novelty during installation.

```bash
npm install --prefer-dedupe

```

--------------------------------

### npm fund example output

Source: https://docs.npmjs.com/cli/v12/commands/npm-fund

Example output of running npm fund in a project with a configured workspace 'a'. Shows the tree structure of funding sources.

```bash
$ npm fund
test-workspaces-fund@1.0.0
+-- https://example.com/a
| | `-- a@1.0.0
| `-- https://example.com/maintainer
|     `-- foo@1.0.0
+-- https://example.com/npmcli-funding
|   `-- @npmcli/test-funding
`-- https://example.com/org
    `-- bar@2.0.0

```

--------------------------------

### Test package with npm install

Source: https://docs.npmjs.com/creating-and-publishing-scoped-public-packages

Run npm install with the full path to your package directory to test the package before publishing.

```bash
npm install /path/to/my-test-package
```

--------------------------------

### Test local install in another folder

Source: https://docs.npmjs.com/cli/v12/using-npm/developers

Go into another folder and install your package locally to test it in a different context.

```bash
cd ../some-other-folder
npm install ../my-package
```

--------------------------------

### bin field as a map

Source: https://docs.npmjs.com/cli/v12/configuring-npm/package-json

Example of the bin field as a map of command name to local file. When installed globally, the file is linked or a cmd file is created; when installed as a dependency, it is available via npm exec or npm run.

```json
{
  "bin": {
    "myapp": "bin/cli.js"
  }
}
```

--------------------------------

### npm install <name>@<version>

Source: https://docs.npmjs.com/cli/install

Installs the specified exact version of the package. Fails if the version has not been published to the registry.

```bash
npm install sax@0.1.1
npm install @myorg/privatepackage@1.5.0
```

--------------------------------

### npm install package for testing

Source: https://docs.npmjs.com/creating-and-publishing-private-packages

Run this command to install your package locally for testing before publishing. Use the full path to your package directory.

```shell
npm install my-package
```

--------------------------------

### Caret dependency ^1.1.1

Source: https://docs.npmjs.com/cli/update

Caret dependency example. Running npm update installs dep1@1.2.2 because it satisfies ^1.1.1.

```json
"dependencies": {
  "dep1": "^1.1.1"
}
```

--------------------------------

### Example dependencies in package.json

Source: https://docs.npmjs.com/about-semantic-versioning

Shows how to specify acceptable version ranges for dependencies in package.json. The example uses ^1.0.0 for minor releases and ~2.2.0 for patch releases.

```json
"dependencies": {
  "my_dep": "^1.0.0",
  "another_dep": "~2.2.0"
},
```

--------------------------------

### Example: Uninstall global jshint

Source: https://docs.npmjs.com/uninstalling-packages-and-dependencies

A concrete example of uninstalling the global jshint package.

```bash
npm uninstall -g jshint
```

--------------------------------

### Install connect package

Source: https://docs.npmjs.com/cli/v12/commands/npm-edit

Install the connect package before using npm edit connect.

```bash
npm install connect
```

--------------------------------

### package.json with executable dependency

Source: https://docs.npmjs.com/cli/v12/using-npm/scripts

Example package.json showing a dependency with an executable script. When you run npm start, the bar executable is added to PATH via node_modules/.bin and executed.

```json
{
  "name": "foo",
  "dependencies": {
    "bar": "0.1.x"
  },
  "scripts": {
    "start": "bar ./test"
  }
}
```

--------------------------------

### Example output of npm prefix -g

Source: https://docs.npmjs.com/cli/v12/commands/npm-prefix

Example output of npm prefix -g showing the global prefix path.

```bash
npm prefix -g
/usr/local
```

--------------------------------

### npm install from Bitbucket

Source: https://docs.npmjs.com/cli/install

Install a package from a Bitbucket repository using the bitbucket: prefix. Supports commit-ish and semver ranges.

```bash
npm install bitbucket:mybitbucketuser/myproject
```

--------------------------------

### homepage field example

Source: https://docs.npmjs.com/cli/v12/configuring-npm/package-json

Example of the homepage field in package.json, a URL string to the project homepage.

```json
"homepage": "https://github.com/npm/example#readme"
```

--------------------------------

### npm install from GitHub repositories

Source: https://docs.npmjs.com/cli/install

Install a package from a GitHub repository using either the shorthand <githubname>/<githubrepo> or the github: prefix. Supports commit-ish and semver ranges.

```bash
npm install mygithubuser/myproject
npm install github:mygithubuser/myproject
```

--------------------------------

### Example: Uninstall lodash

Source: https://docs.npmjs.com/uninstalling-packages-and-dependencies

A concrete example of uninstalling the lodash package.

```bash
npm uninstall lodash
```

--------------------------------

### npm install from GitLab

Source: https://docs.npmjs.com/cli/install

Install a package from a GitLab repository using the gitlab: prefix. Supports commit-ish and semver ranges.

```bash
npm install gitlab:mygitlabuser/myproject
npm install gitlab:myusr/myproj#semver:^5.0
```

--------------------------------

### Install unscoped public package with npm install

Source: https://docs.npmjs.com/downloading-and-installing-packages-locally

Installs an unscoped public package locally, creating a node_modules directory if needed. Installs the latest version when no package.json is present, or the latest version satisfying a semver rule from package.json.

```bash
npm install <package_name>
```

--------------------------------

### peerDependencies example with dependency graph

Source: https://docs.npmjs.com/files/package.json

Declare a peer dependency to express compatibility with a host package without requiring it. The example shows `@npm/tea-latte` requiring `@npm/tea` version 2.x, and the resulting dependency graph when installing `tea-latte`. As of npm v7, peerDependencies are installed by default; in npm 3-6 they were not automatically installed and would raise a warning on invalid versions.

```json
{
  "name": "@npm/tea-latte",
  "version": "1.3.5",
  "peerDependencies": {
    "@npm/tea": "2.x"
  }
}
```

```text
├── @npm/tea-latte@1.3.5
└── @npm/tea@2.2.0
```

--------------------------------

### bundleDependencies example

Source: https://docs.npmjs.com/cli/v12/configuring-npm/package-json

Example package.json using bundleDependencies to bundle specific packages when running npm pack. The resulting tarball includes the listed dependencies.

```json
{
  "name": "@npm/awesome-web-framework",
  "version": "1.0.0",
  "bundleDependencies": ["@npm/renderized", "@npm/super-streams"]
}
```

--------------------------------

### npm install from a gist

Source: https://docs.npmjs.com/cli/install

Install a package from a gist by its ID. The GitHub username is optional and not saved in package.json.

```bash
npm install gist:101a11beef
```

--------------------------------

### Equivalent npm init and npm exec with options

Source: https://docs.npmjs.com/cli/v12/commands/npm-init

Shows two equivalent commands that pass options to both the npm CLI and the create package, illustrating how npm init maps to npm exec.

```bash
npm init foo -y --registry=<url> -- --hello -a
npm exec -y --registry=<url> -- create-foo --hello -a

```

--------------------------------

### Workspaces configuration with order a then b

Source: https://docs.npmjs.com/cli/v12/using-npm/workspaces

Example package.json workspaces configuration listing workspaces in order a then b. Commands run in the order they appear.

```json
{
  "workspaces": [ "packages/a", "packages/b" ]
}
```

--------------------------------

### Git URL dependency examples

Source: https://docs.npmjs.com/cli/v12/configuring-npm/package-json

Examples of Git URLs used as dependencies, showing different protocols and commit-ish or semver suffixes.

```text
git+ssh://git@github.com:npm/cli.git#v1.0.27
git+ssh://git@github.com:npm/cli#semver:^5.0
git+https://isaacs@github.com/npm/cli.git
git://github.com/npm/cli.git#v1.0.27
```

--------------------------------

### min-release-age-exclude configuration example

Source: https://docs.npmjs.com/cli/install

Example configuration for exempting packages from the release-age filter. Sets min-release-age to 7 days and excludes @myorg/* and my-internal-pkg from the filter.

```ini
min-release-age=7
min-release-age-exclude[]=@myorg/*
min-release-age-exclude[]=my-internal-pkg
```

--------------------------------

### Using node_modules/.bin prefix in scripts

Source: https://docs.npmjs.com/cli/v12/commands/npm-run

Contrasts with the previous example by showing the explicit path to the binary, which is not necessary when using npm run.

```json
"scripts": {"test": "node_modules/.bin/tap test/*.js"}

```

--------------------------------

### npm pkg get nested field

Source: https://docs.npmjs.com/cli/v12/commands/npm-pkg

Retrieves a child field by separating properties with a period. This example gets the value of the 'test' script from the 'scripts' object.

```bash
npm pkg get scripts.test
```

--------------------------------

### npm install <name>@<version range>

Source: https://docs.npmjs.com/cli/install

Installs a version matching the specified version range. Most version ranges must be quoted so the shell treats them as a single argument.

```bash
npm install sax@">=0.1.0 <0.2.0"
npm install @myorg/privatepackage@"16 - 17"
```

--------------------------------

### npm pkg get array field values

Source: https://docs.npmjs.com/cli/v12/commands/npm-pkg

For array fields, requesting a non-numeric field returns all values from the objects in the list. This example gets all contributor emails.

```bash
npm pkg get contributors.email
```

--------------------------------

### npm install <name>@<tag>

Source: https://docs.npmjs.com/cli/install

Installs the version of the package referenced by the specified tag. Fails if the tag does not exist in the registry data for that package.

```bash
npm install sax@latest
npm install @myorg/mypackage@latest
```

--------------------------------

### npm fund with workspace filter example

Source: https://docs.npmjs.com/cli/v12/commands/npm-fund

Example output of npm fund filtered by workspace 'a' using the -w option. Shows only the funding sources for that workspace.

```bash
$ npm fund -w a
test-workspaces-fund@1.0.0
`-- https://example.com/a
  | `-- a@1.0.0
  `-- https://example.com/maintainer
      `-- foo@2.0.0

```

--------------------------------

### npm deny-scripts examples

Source: https://docs.npmjs.com/cli/v12/commands/npm-deny-scripts

Two example invocations of npm deny-scripts: one to deny a specific package (telemetry-pkg) and one to deny all packages with install scripts that are not already approved.

```bash
# Deny a specific package outright
npm deny-scripts telemetry-pkg
```

```bash
# Deny everything that has install scripts and isn't already approved
npm deny-scripts --all
```

--------------------------------

### npm pkg get array index

Source: https://docs.npmjs.com/cli/v12/commands/npm-pkg

Uses a numeric index in square brackets to select a specific item in an array field. This example gets the email of the first contributor.

```bash
npm pkg get contributors[0].email
```

--------------------------------

### Test global install without sudo

Source: https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally

Install a package globally without using sudo to verify the new configuration works.

```bash
npm install -g npm-check-updates
```

--------------------------------

### npm install with multiple arguments

Source: https://docs.npmjs.com/cli/install

Combine multiple package arguments of different types in a single npm install command.

```bash
npm install sax@">=0.1.0 <0.2.0" bench supervisor
```

--------------------------------

### Example: Add stable tag to example-package@1.4.0

Source: https://docs.npmjs.com/adding-dist-tags-to-packages

Adds the 'stable' dist-tag to version 1.4.0 of 'example-package'.

```bash
npm dist-tag add example-package@1.4.0 stable
```

--------------------------------

### Local path dependency in package.json

Source: https://docs.npmjs.com/cli/v12/configuring-npm/package-json

Example of a package.json with a local path dependency using the file: prefix. Note that packages linked by local path will not have their own dependencies installed when npm install is run.

```json
{
  "name": "baz",
  "dependencies": {
    "bar": "file:../foo/bar"
  }
}
```

--------------------------------

### npm explain folder path example

Source: https://docs.npmjs.com/cli/v12/commands/npm-explain

Command and output for explaining a package residing at a specific folder. Useful for understanding why a dependency is duplicated to satisfy conflicting version requirements.

```bash
$ npm explain node_modules/nyc/node_modules/find-up
find-up@3.0.0 dev
node_modules/nyc/node_modules/find-up
  find-up@"^3.0.0" from nyc@14.1.1
  node_modules/nyc
    nyc@"^14.1.1" from tap@14.10.8
    node_modules/tap
      dev tap@"^14.10.8" from the root project
```

--------------------------------

### npm install <git remote url> format

Source: https://docs.npmjs.com/cli/install

Format for installing a package from a git remote URL. Only the full URL is attempted when cloning with git.

```text
<protocol>://[<user>[:<password>]@]<hostname>[:<port>][:][/]<path>[#<commit-ish> | #semver:<semver>]
```

--------------------------------

### Subdependencies example with dep2

Source: https://docs.npmjs.com/cli/update

Subdependencies example: the app's package.json and dep2's package.json. npm update installs dep1@1.1.2 because dep2 allows that range, prioritizing a single version in the tree.

```json
{
  "name": "my-app",
  "dependencies": {
    "dep1": "^1.0.0",
    "dep2": "1.0.0"
  }
}
```

```json
{
  "name": "dep2",
  "dependencies": {
    "dep1": "~1.1.1"
  }
}
```

--------------------------------

### Check npm and Node.js versions

Source: https://docs.npmjs.com/cli/v12/configuring-npm/install

Run these commands to see if Node.js and npm are already installed and to check their versions.

```bash
node -v
npm -v
```

--------------------------------

### npm init syntax and aliases

Source: https://docs.npmjs.com/cli/v12/commands/npm-init

Shows the basic syntax for the npm init command, including the package-spec and scope forms, and lists the aliases 'create' and 'innit'.

```bash
npm init <package-spec> (same as `npx create-<package-spec>`)
npm init <@scope> (same as `npx <@scope>/create`)


aliases: create, innit

```

--------------------------------

### npm pkg get exports property

Source: https://docs.npmjs.com/cli/v12/commands/npm-pkg

Uses a property name in square brackets to select a child field, especially helpful with the exports object. This example gets the 'require' condition from the exports object.

```bash
npm pkg get "exports[.].require"
```

--------------------------------

### Example response for missing registry signatures

Source: https://docs.npmjs.com/verifying-registry-signatures

Example response when some versions have missing registry signatures. The CLI errors if packages lack signatures and the registry supports signatures, indicating a possible attack.

```text
audited 1640 packages in 2s

1405 packages have verified registry signatures

235 packages have missing registry signatures but the registry is providing signing keys:

missing-dep@1.0.0 (https://registry.npmjs.org/)
...
```

--------------------------------

### Caret dependency ^0.2.0

Source: https://docs.npmjs.com/cli/update

Caret dependency below 1.0.0 example. npm update installs dep1@0.2.0.

```json
"dependencies": {
  "dep1": "^0.2.0"
}
```

--------------------------------

### Run npm init CLI questionnaire

Source: https://docs.npmjs.com/creating-a-package-json-file

Navigate to the package root directory and run the npm init command to start the CLI questionnaire. Answer the questions to create a package.json with your supplied values.

```bash
cd /path/to/package
```

```bash
npm init
```

--------------------------------

### Define workspaces in package.json

Source: https://docs.npmjs.com/cli/v12/using-npm/workspaces

Example package.json with a workspaces property listing 'packages/a'.

```json
{
  "name": "my-workspaces-powered-project",
  "workspaces": ["packages/a"]
}
```

--------------------------------

### Create package directory and initialize git

Source: https://docs.npmjs.com/creating-and-publishing-unscoped-public-packages

Commands to create a directory for the package, navigate into it, and initialize a git repository with a remote URL. Replace git-remote-url with the actual remote URL.

```bash
mkdir my-test-package
```

```bash
cd my-test-package
```

```bash
git init
git remote add origin git://git-remote-url

```

--------------------------------

### npm install-test synopsis and alias

Source: https://docs.npmjs.com/cli/v12/commands/npm-install-test

The synopsis shows the primary command syntax for npm install-test, which runs an npm install followed immediately by an npm test. The alias 'it' is also provided as a shorthand.

```bash
npm install-test [<package-spec> ...]
```

```bash
alias: it
```

--------------------------------

### npm diff output example

Source: https://docs.npmjs.com/cli/v12/commands/npm-diff

Example output of a successful npm diff command, showing the diff patch for the package.json file between versions 1.1.0 and 1.1.1.

```diff
diff --git a/package.json b/package.json
index v1.1.0..v1.1.1 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "abbrev",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Like ruby's abbrev module, but in js",
   "author": "Isaac Z. Schlueter <i@izs.me>",
   "main": "abbrev.js",
```

--------------------------------

### Initialize a workspace with npm init -w

Source: https://docs.npmjs.com/cli/v12/using-npm/workspaces

Creates the missing folders and a new package.json file (if needed) for the workspace at ./packages/a, and configures the "workspaces" property of the root package.json.

```bash
npm init -w ./packages/a
```

--------------------------------

### SPDX SBOM JSON example

Source: https://docs.npmjs.com/cli/v12/commands/npm-sbom

Example SPDX 2.3 SBOM in JSON format, showing the structure for a package named 'simple' and its dependency 'lodash'. Includes document metadata, package details, and dependency relationships.

```json
{
  "spdxVersion": "SPDX-2.3",
  "dataLicense": "CC0-1.0",
  "SPDXID": "SPDXRef-DOCUMENT",
  "name": "simple@1.0.0",
  "documentNamespace": "http://spdx.org/spdxdocs/simple-1.0.0-bf81090e-8bbc-459d-bec9-abeb794e096a",
  "creationInfo": {
    "created": "2023-09-01T00:00:00.001Z",
    "creators": ["Tool: npm/cli-10.1.0"]
  },
  "documentDescribes": ["SPDXRef-Package-simple-1.0.0"],
  "packages": [
    {
      "name": "simple",
      "SPDXID": "SPDXRef-Package-simple-1.0.0",
      "versionInfo": "1.0.0",
      "packageFileName": "",
      "description": "simple react app",
      "primaryPackagePurpose": "LIBRARY",
      "downloadLocation": "NOASSERTION",
      "filesAnalyzed": false,
      "homepage": "NOASSERTION",
      "licenseDeclared": "MIT",
      "externalRefs": [
        {
          "referenceCategory": "PACKAGE-MANAGER",
          "referenceType": "purl",
          "referenceLocator": "pkg:npm/simple@1.0.0"
        }
      ]
    },
    {
      "name": "lodash",
      "SPDXID": "SPDXRef-Package-lodash-4.17.21",
      "versionInfo": "4.17.21",
      "packageFileName": "node_modules/lodash",
      "description": "Lodash modular utilities.",
      "downloadLocation": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz",
      "filesAnalyzed": false,
      "homepage": "https://lodash.com/",
      "licenseDeclared": "MIT",
      "externalRefs": [
        {
          "referenceCategory": "PACKAGE-MANAGER",
          "referenceType": "purl",
          "referenceLocator": "pkg:npm/lodash@4.17.21"
        }
      ],
      "checksums": [
        {
          "algorithm": "SHA512",
          "checksumValue": "bf690311ee7b95e713ba568322e3533f2dd1cb880b189e99d4edef13592b81764daec43e2c54c61d5c558dc5cfb35ecb85b65519e74026ff17675b6f8f916f4a"
        }
      ]
    }
  ],
  "relationships": [
    {
      "spdxElementId": "SPDXRef-DOCUMENT",
      "relatedSpdxElement": "SPDXRef-Package-simple-1.0.0",
      "relationshipType": "DESCRIBES"
    },
    {
      "spdxElementId": "SPDXRef-Package-simple-1.0.0",
      "relatedSpdxElement": "SPDXRef-Package-lodash-4.17.21",
      "relationshipType": "DEPENDS_ON"
    }
  ]
}
```

--------------------------------

### Caret dependency ^0.4.0

Source: https://docs.npmjs.com/cli/update

Caret dependency below 1.0.0 example. npm update installs dep1@0.4.1 because it is the highest-sorting version satisfying ^0.4.0.

```json
"dependencies": {
  "dep1": "^0.4.0"
}
```

--------------------------------

### File structure before npm install

Source: https://docs.npmjs.com/cli/v12/using-npm/workspaces

Directory tree showing the root package and the workspace package 'packages/a'.

```text
.
+-- package.json
`-- packages
   +-- a
   |   `-- package.json
```

--------------------------------

### Subdependencies example - dep2 package.json

Source: https://docs.npmjs.com/cli/v12/commands/npm-update

Shows the package.json of dep2, which depends on dep1 with a tilde range ~1.1.1, limiting the version npm update can install.

```json
{
  "name": "dep2",
  "dependencies": {
    "dep1": "~1.1.1"
  }
}

```

--------------------------------

### Example package.json with stop script

Source: https://docs.npmjs.com/cli/v12/commands/npm-stop

Defines a 'stop' script in the package.json 'scripts' object that runs 'node bar.js'.

```json
{
  "scripts": {
    "stop": "node bar.js"
  }
}
```

--------------------------------

### Use install-strategy=linked to catch undeclared dependencies

Source: https://docs.npmjs.com/cli/v12/using-npm/developers

Run these commands to set up an isolated layout that only exposes declared dependencies, helping catch phantom dependencies during development.

```bash
npm install --install-strategy=linked
npm test
```

--------------------------------

### Comments and scoped registry in .npmrc

Source: https://docs.npmjs.com/cli/v12/configuring-npm/npmrc

Shows comment syntax in .npmrc files: lines starting with # or ; are comments. The example also sets a custom registry for a scoped package.

```ini
# last modified: 01 Jan 2016
; Set a new registry for a scoped package
@myscope:registry=https://mycustomregistry.example.org
```

--------------------------------

### Create default package.json with npm init --yes

Source: https://docs.npmjs.com/creating-a-package-json-file

Navigate to the package root directory and run npm init with the --yes (or -y) flag to create a default package.json using information extracted from the current directory.

```bash
cd /path/to/package
```

```bash
npm init --yes
```

--------------------------------

### ENV NPM_TOKEN example (ineffective for build)

Source: https://docs.npmjs.com/docker-and-private-modules

An ENV line that sets NPM_TOKEN, but it does not work for npm install during docker build because ENV variables are only set for runtime, not build time.

```dockerfile
ENV NPM_TOKEN=00000000-0000-0000-0000-000000000000

```

--------------------------------

### Verify npm global prefix

Source: https://docs.npmjs.com/try-the-latest-stable-version-of-npm

Run `npm config get prefix -g` to see where npm will install global packages. This helps verify the built-in Windows configuration is correct.

```bash
npm config get prefix -g
```

--------------------------------

### devEngines field: enforce runtime and package manager

Source: https://docs.npmjs.com/cli/v12/configuring-npm/package-json

Specifies devEngines to enforce consistent tooling. This example fails if the environment is not node and npm. The devEngines field runs before install, ci, and run commands.

```json
{
  "devEngines": {
    "runtime": {
      "name": "node",
      "onFail": "error"
    },
    "packageManager": {
      "name": "npm",
      "onFail": "error"
    }
  }
}
```

--------------------------------

### npm install-scripts subcommands synopsis

Source: https://docs.npmjs.com/cli/v12/commands/npm-install-scripts

Shows the full synopsis of the install-scripts subcommands: approve, deny, ls, and prune, including the --all flag. Use this as a quick reference for the command syntax.

```bash
npm install-scripts approve <pkg> [<pkg> ...]
npm install-scripts approve --all
npm install-scripts deny <pkg> [<pkg> ...]
npm install-scripts deny --all
npm install-scripts ls
npm install-scripts prune

```

--------------------------------

### devDependencies with prepare script

Source: https://docs.npmjs.com/cli/v12/configuring-npm/package-json

Example package.json showing how to use devDependencies with a prepare script to compile CoffeeScript before publishing. The prepare script runs before publishing and also during local npm install, so users don't need to compile the source themselves.

```json
{
  "name": "@npm/ethopia-waza",
  "description": "a delightfully fruity coffee varietal",
  "version": "1.2.3",
  "devDependencies": {
    "coffee-script": "~1.6.3"
  },
  "scripts": {
    "prepare": "coffee -o lib/ -c src/waza.coffee"
  },
  "main": "lib/waza.js"
}
```

--------------------------------

### Edit connect package

Source: https://docs.npmjs.com/cli/v12/commands/npm-edit

Open the locally installed connect package in the editor. The package is rebuilt after you make changes.

```bash
npm edit connect
```

--------------------------------

### Install scoped public package with npm install

Source: https://docs.npmjs.com/downloading-and-installing-packages-locally

Installs a scoped public package. The scope name must be referenced in the install command.

```bash
npm install @scope/package-name
```

--------------------------------

### Install scoped package with npm install

Source: https://docs.npmjs.com/cli/v12/using-npm/scope

Command to install a scoped package by referencing its full name with the @ symbol.

```bash
npm install @myorg/mypackage
```

--------------------------------

### List installed packages with ls node_modules

Source: https://docs.npmjs.com/downloading-and-installing-packages-locally

Verifies npm install by checking the node_modules directory contains the installed package(s).

```bash
ls node_modules
```

--------------------------------

### Two-step npm link example

Source: https://docs.npmjs.com/cli/v12/commands/npm-link

Two-step process: first create a global link in the package folder, then link it into another project. The link uses the package name from package.json, not the directory name.

```bash
cd ~/projects/node-redis    # go into the package directory
npm link                    # creates global link
cd ~/projects/node-bloggy   # go into some other package directory.
npm link redis              # link-install the package
```

--------------------------------

### Workspaces configuration with order b then a

Source: https://docs.npmjs.com/cli/v12/using-npm/workspaces

Example package.json workspaces configuration listing workspaces in order b then a, which changes the order of execution.

```json
{
  "workspaces": [ "packages/b", "packages/a" ]
}
```

--------------------------------

### Install Node.js on macOS with Homebrew

Source: https://docs.npmjs.com/try-the-latest-stable-version-of-node

Install the latest Node.js version on macOS using Homebrew. This is an alternative to downloading the installer from the official website.

```bash
brew install node
```

--------------------------------

### Using local binaries in scripts

Source: https://docs.npmjs.com/cli/v12/commands/npm-run

Shows how to use a locally installed binary (tap) without the node_modules/.bin prefix, because npm run adds that directory to PATH.

```json
"scripts": {"test": "tap test/*.js"}

```

--------------------------------

### Install private package with npm install

Source: https://docs.npmjs.com/downloading-and-installing-packages-locally

Installs a private scoped package. Requires read access to the package and the scope name must be referenced in the command.

```bash
npm install @scope/private-package-name
```

--------------------------------

### Equivalent two-step npm link commands

Source: https://docs.npmjs.com/cli/v12/commands/npm-link

Equivalent to the shortcut command: first creates a global link, then links the global installation target into the project's node_modules folder.

```bash
(cd ../node-redis; npm link)
npm link redis
```

--------------------------------

### optionalDependencies in package.json

Source: https://docs.npmjs.com/cli/v12/configuring-npm/package-json

Declares an optional dependency in package.json. Build failures for this dependency do not cause installation to fail, and running `npm install --omit=optional` prevents it from being installed.

```json
{
  "optionalDependencies": {
    "@npm/foo": "^1.0.0"
  }
}
```

--------------------------------

### npm login command with security-key flow

Source: https://docs.npmjs.com/accessing-npm-using-2fa

Run `npm login` and follow the prompts. The output shows the login notice, username, password, and email prompts, and a URL to open for security-key authentication or OTP entry.

```bash
user@host:~$ npm login
npm notice Log in on https://registry.npmjs.org/
Username: mona
Password:
Email: (this IS public) mona@github.com
npm notice Open https://www.npmjs.com/login/913c3ab1-89a0-44bd-be8d-d946e2e906f0 to use your security key for authentication or enter OTP from your authenticator app
```

--------------------------------

### bin field as a map (equivalent)

Source: https://docs.npmjs.com/cli/v12/configuring-npm/package-json

Equivalent map form of the string bin example, using the package name as the command name.

```json
{
  "name": "my-program",
  "version": "1.2.5",
  "bin": {
    "my-program": "path/to/program"
  }
}
```

--------------------------------

### npm init -w packages/a

Source: https://docs.npmjs.com/cli/v12/commands/npm-init

Creates a new workspace using the legacy init with the -w option. The command generates a folder and package.json for the workspace and updates the top-level package.json to reference it.

```bash
$ npm init -w packages/a

```

--------------------------------

### package.json with prepare, build, and test scripts

Source: https://docs.npmjs.com/cli/v12/using-npm/scripts

Example package.json showing how to run build commands via npm scripts. The prepare script runs npm run build, which in turn runs the build script (tsc). The test script runs jest.

```json
{
  "scripts": {
    "prepare": "npm run build",
    "build": "tsc",
    "test": "jest"
  }
}
```

--------------------------------

### npm init -w with initializer

Source: https://docs.npmjs.com/cli/v12/commands/npm-init

Creates a new React app as a nested workspace using the initializer syntax. The dot represents the current directory in the context of the newly created workspace folder.

```bash
npm init -w packages/my-react-app react-app .

```

--------------------------------

### View information about the connect package

Source: https://docs.npmjs.com/cli/v12/commands/npm-view

Displays registry data for the connect package.

```bash
npm view connect
```

--------------------------------

### Forward options to create package

Source: https://docs.npmjs.com/cli/v12/commands/npm-init

Demonstrates forwarding additional options to the create package by using '--' before the options.

```bash
npm init foo -- --hello

```

--------------------------------

### package.json workspaces example

Source: https://docs.npmjs.com/cli/v12/configuring-npm/package-json

Defines a workspace configuration in package.json. All folders inside ./packages with valid package.json files are treated as workspaces.

```json
{
  "name": "workspace-example",
  "workspaces": ["./packages/*"]
}
```

--------------------------------

### Verify registry signatures with npm audit signatures

Source: https://docs.npmjs.com/verifying-registry-signatures

Run this command to verify registry signatures for all installed packages. Requires npm CLI v8.15.0 or later and dependencies installed via npm install or npm ci.

```bash
npm audit signatures
```

--------------------------------

### Dockerfile with build secrets for private modules

Source: https://docs.npmjs.com/docker-and-private-modules

A Dockerfile that uses Docker build secrets to mount the .npmrc file during npm install, leaving no trace after installation. It sets a working directory and copies package files before installing dependencies.

```dockerfile
# https://docs.npmjs.com/docker-and-private-modules
FROM node:18


ENV APP_HOME="/app"


WORKDIR ${APP_HOME}


COPY package*.json ${APP_HOME}/


RUN --mount=type=secret,id=npmrc,target=/root/.npmrc npm install


COPY . ${APP_HOME}/


CMD npm start

```

--------------------------------

### npm init to npm exec transformations

Source: https://docs.npmjs.com/cli/v12/commands/npm-init

Lists the transformations from npm init commands to their corresponding npm exec operations, showing how initializer names and scopes are mapped.

```bash
npm init foo -> npm exec create-foo
npm init @usr/foo -> npm exec @usr/create-foo
npm init @usr -> npm exec @usr/create
npm init @usr@2.0.0 -> npm exec @usr/create@2.0.0
npm init @usr/foo@2.0.0 -> npm exec @usr/create-foo@2.0.0

```

--------------------------------

### Default install hook for binding.gyp

Source: https://docs.npmjs.com/cli/v12/commands/npm-rebuild

Default install hook used when a binding.gyp file is present in the package root. This behavior is suppressed if the package.json defines its own install or preinstall scripts, or if the package specifies "gypfile": false.

```json
"scripts": {
    "install": "node-gyp rebuild"
}
```
Tokens:
Raw