1--- 2section: cli-commands 3title: npm-docs 4description: Docs for a package in a web browser maybe 5--- 6 7# npm-docs(1) 8 9## Docs for a package in a web browser maybe 10 11### Synopsis 12 13```bash 14npm docs [<pkgname> [<pkgname> ...]] 15npm docs . 16npm home [<pkgname> [<pkgname> ...]] 17npm home . 18``` 19 20### Description 21 22This command tries to guess at the likely location of a package's 23documentation URL, and then tries to open it using the `--browser` 24config param. You can pass multiple package names at once. If no 25package name is provided, it will search for a `package.json` in 26the current folder and use the `name` property. 27 28### Configuration 29 30#### browser 31 32* Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"` 33* Type: String 34 35The browser that is called by the `npm docs` command to open websites. 36 37#### registry 38 39* Default: https://registry.npmjs.org/ 40* Type: url 41 42The base URL of the npm package registry. 43 44 45### See Also 46 47* [npm view](/cli-commands/npm-view) 48* [npm publish](/cli-commands/npm-publish) 49* [npm registry](/using-npm/registry) 50* [npm config](/cli-commands/npm-config) 51* [npmrc](/configuring-npm/npmrc) 52* [package.json](/configuring-npm/package-json) 53