/snap/node/11691/lib/node_modules/npm/docs/content/commands
NameSizeModeActions
npm-access.md36640644editdlrm
npm-adduser.md18470644editdlrm
npm-audit.md156560644editdlrm
npm-bugs.md29960644editdlrm
npm-cache.md29620644editdlrm
npm-ci.md91250644editdlrm
npm-completion.md9090644editdlrm
npm-config.md40930644editdlrm
npm-dedupe.md88950644editdlrm
npm-deprecate.md17410644editdlrm
npm-diff.md91090644editdlrm
npm-dist-tag.md51810644editdlrm
npm-docs.md29740644editdlrm
npm-doctor.md50570644editdlrm
npm-edit.md10910644editdlrm
npm-exec.md114010644editdlrm
npm-explain.md27950644editdlrm
npm-explore.md10060644editdlrm
npm-find-dupes.md67970644editdlrm
npm-fund.md36730644editdlrm
npm-help-search.md7560644editdlrm
npm-help.md10040644editdlrm
npm-hook.md23940644editdlrm
npm-init.md98550644editdlrm
npm-install-ci-test.md74340644editdlrm
npm-install-test.md98140644editdlrm
npm-install.md249840644editdlrm
npm-link.md117420644editdlrm
npm-login.md21710644editdlrm
npm-logout.md17490644editdlrm
npm-ls.md85470644editdlrm
npm-org.md19750644editdlrm
npm-outdated.md57790644editdlrm
npm-owner.md30930644editdlrm
npm-pack.md34480644editdlrm
npm-ping.md7690644editdlrm
npm-pkg.md81290644editdlrm
npm-prefix.md12110644editdlrm
npm-profile.md31020644editdlrm
npm-prune.md57450644editdlrm
npm-publish.md76220644editdlrm
npm-query.md69580644editdlrm
npm-rebuild.md50010644editdlrm
npm-repo.md27540644editdlrm
npm-restart.md14730644editdlrm
npm-root.md10970644editdlrm
npm-run-script.md75610644editdlrm
npm-sbom.md83370644editdlrm
npm-search.md34640644editdlrm
npm-shrinkwrap.md9230644editdlrm
npm-star.md17130644editdlrm
npm-stars.md7430644editdlrm
npm-start.md16670644editdlrm
npm-stop.md13410644editdlrm
npm-team.md40900644editdlrm
npm-test.md12340644editdlrm
npm-token.md28930644editdlrm
npm-uninstall.md44470644editdlrm
npm-unpublish.md44910644editdlrm
npm-unstar.md15740644editdlrm
npm-update.md118710644editdlrm
npm-version.md69020644editdlrm
npm-view.md56120644editdlrm
npm-whoami.md8000644editdlrm
npm.md56700644editdlrm
npx.md58950644editdlrm
Edit: /snap/node/11691/lib/node_modules/npm/docs/content/commands/npm-view.md (5612B)
--- title: npm-view section: 1 description: View registry info --- ### Synopsis ```bash npm view [] [[.subfield]...] aliases: info, show, v ``` ### Description This command shows data about a package and prints it to stdout. As an example, to view information about the `connect` package from the registry, you would run: ```bash npm view connect ``` The default version is `"latest"` if unspecified. Field names can be specified after the package descriptor. For example, to show the dependencies of the `ronn` package at version `0.3.5`, you could do the following: ```bash npm view ronn@0.3.5 dependencies ``` By default, `npm view` shows data about the current project context (by looking for a `package.json`). To show field data for the current project use a file path (i.e. `.`): ```bash npm view . dependencies ``` You can view child fields by separating them with a period. To view the git repository URL for the latest version of `npm`, you would run the following command: ```bash npm view npm repository.url ``` This makes it easy to view information about a dependency with a bit of shell scripting. For example, to view all the data about the version of `opts` that `ronn` depends on, you could write the following: ```bash npm view opts@$(npm view ronn dependencies.opts) ``` For fields that are arrays, requesting a non-numeric field will return all of the values from the objects in the list. For example, to get all the contributor email addresses for the `express` package, you would run: ```bash npm view express contributors.email ``` You may also use numeric indices in square braces to specifically select an item in an array field. To just get the email address of the first contributor in the list, you can run: ```bash npm view express contributors[0].email ``` If the field value you are querying for is a property of an object, you should run: ```bash npm view express time'[4.8.0]' ``` Multiple fields may be specified, and will be printed one after another. For example, to get all the contributor names and email addresses, you can do this: ```bash npm view express contributors.name contributors.email ``` "Person" fields are shown as a string if they would be shown as an object. So, for example, this will show the list of `npm` contributors in the shortened string format. (See [`package.json`](/configuring-npm/package-json) for more on this.) ```bash npm view npm contributors ``` If a version range is provided, then data will be printed for every matching version of the package. This will show which version of `jsdom` was required by each matching version of `yui3`: ```bash npm view yui3@'>0.5.4' dependencies.jsdom ``` To show the `connect` package version history, you can do this: ```bash npm view connect versions ``` ### Configuration #### `json` * Default: false * Type: Boolean Whether or not to output JSON data, rather than the normal output. * In `npm pkg set` it enables parsing set values with JSON.parse() before saving them to your `package.json`. Not supported by all npm commands. #### `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 the `workspace` 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 the `npm 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 of **all** configured workspaces. Explicitly setting this to false will cause commands like `install` to ignore workspaces altogether. When not set explicitly: - Commands that operate on the `node_modules` tree (install, update, etc.) will link workspaces into the `node_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 the `workspace` 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 the `workspace` config, or all workspaces via the `workspaces` 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. ### Output If only a single string field for a single version is output, then it will not be colorized or quoted, to enable piping the output to another command. If the field is an object, it will be output as a JavaScript object literal. If the `--json` flag is given, the outputted fields will be JSON. If the version range matches multiple versions then each printed value will be prefixed with the version it applies to. If multiple fields are requested, then each of them is prefixed with the field name. ### See Also * [package spec](/using-npm/package-spec) * [npm search](/commands/npm-search) * [npm registry](/using-npm/registry) * [npm config](/commands/npm-config) * [npmrc](/configuring-npm/npmrc) * [npm docs](/commands/npm-docs)