Synopsis

npm docs[<pkgname>[<pkgname>...]]
alias: 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 no package name is provided, it will search for apackage.json in the current folder and use thename property.

Configuration

browser

• Default: OS X:"open", Windows:"start", Others:"xdg-open"
• Type: null, Boolean, or String

The browser that is called by npm commands to open websites.

Set tofalse to suppress browser behavior and instead print urls to terminal.

Set totrue to use default system URL opener.

registry

• Default: "https://registry.npmjs.org/"
• Type: URL

The base URL of the npm registry.

workspace

• Default:
• Type: String (can be set multiple times)

Enable running a command in the context of the configured workspaces of the current project while filtering by running only the workspaces defined by this configuration option.

Valid values for theworkspace config are either:

• Workspace names
• Path to a workspace directory
• Path to a parent workspace directory (will result in selecting all workspaces within that folder)

When set for thenpm init command, this may be set to the folder of a workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.

This value is not exported to the environment for child processes.

workspaces

• Default: null
• Type: null or Boolean

Set to true to run the command in the context ofall configured workspaces.

Explicitly setting this to false will cause commands likeinstall to ignore workspaces altogether. When not set explicitly:

• Commands that operate on thenode_modules tree (install, update, etc.) will link workspaces into thenode_modules folder. - Commands that do other things (test, exec, publish, etc.) will operate on the root project,unless one or more workspaces are specified in theworkspace config.

This value is not exported to the environment for child processes.

include-workspace-root

• Default: false
• Type: Boolean

Include the workspace root when workspaces are enabled for a command.

When false, specifying individual workspaces via theworkspace config, or all workspaces via theworkspaces flag, will cause npm to operate only on the specified workspaces, and not on the root project.

This value is not exported to the environment for child processes.

See Also

• npm view
• npm publish
• npm registry
• npm config
• npmrc
• package.json

Edit this page on GitHub

1 contributorlukekarrys

Last edited bylukekarrys onOctober 5, 2022