├── .eslint.config.js ├── .eslintrc.js ├── .github ├── CODEOWNERS ├── ISSUE_TEMPLATE │ └── config.yml ├── actions │ ├── create-check │ │ └── action.yml │ └── install-latest-npm │ │ └── action.yml ├── dependabot.yml ├── matchers │ └── tap.json └── workflows │ ├── audit.yml │ ├── ci-cli.yml │ ├── ci.yml │ ├── codeql-analysis.yml │ ├── post-dependabot.yml │ ├── publish.yml │ └── update-cli.yml ├── .gitignore ├── .npmrc ├── .nvmrc ├── .prettierignore ├── .prettierrc.js ├── .reuse └── dep5 ├── CODE_OF_CONDUCT.md ├── CONTENT-MODEL.md ├── CONTRIBUTING.md ├── LICENSE ├── LICENSE-CODE ├── LICENSES ├── CC-BY-4.0.txt └── MIT.txt ├── README.md ├── SECURITY.md ├── cli-cache.json ├── cli ├── .gitignore ├── bin │ └── build.js ├── lib │ ├── build.js │ ├── cache.js │ ├── extract.js │ ├── gh.js │ ├── log.js │ ├── redirects.js │ └── transform.js ├── package.json ├── releases.json ├── scripts │ └── template-oss │ │ ├── _step-deps-yml.hbs │ │ ├── index.js │ │ └── update-cli-yml.hbs └── test │ ├── index.js │ └── transform.js ├── content ├── 404.mdx ├── about-npm │ └── index.mdx ├── cli │ ├── v10 │ │ ├── commands │ │ │ ├── index.mdx │ │ │ ├── npm-access.mdx │ │ │ ├── npm-adduser.mdx │ │ │ ├── npm-audit.mdx │ │ │ ├── npm-bugs.mdx │ │ │ ├── npm-cache.mdx │ │ │ ├── npm-ci.mdx │ │ │ ├── npm-completion.mdx │ │ │ ├── npm-config.mdx │ │ │ ├── npm-dedupe.mdx │ │ │ ├── npm-deprecate.mdx │ │ │ ├── npm-diff.mdx │ │ │ ├── npm-dist-tag.mdx │ │ │ ├── npm-docs.mdx │ │ │ ├── npm-doctor.mdx │ │ │ ├── npm-edit.mdx │ │ │ ├── npm-exec.mdx │ │ │ ├── npm-explain.mdx │ │ │ ├── npm-explore.mdx │ │ │ ├── npm-find-dupes.mdx │ │ │ ├── npm-fund.mdx │ │ │ ├── npm-help-search.mdx │ │ │ ├── npm-help.mdx │ │ │ ├── npm-hook.mdx │ │ │ ├── npm-init.mdx │ │ │ ├── npm-install-ci-test.mdx │ │ │ ├── npm-install-test.mdx │ │ │ ├── npm-install.mdx │ │ │ ├── npm-link.mdx │ │ │ ├── npm-login.mdx │ │ │ ├── npm-logout.mdx │ │ │ ├── npm-ls.mdx │ │ │ ├── npm-org.mdx │ │ │ ├── npm-outdated.mdx │ │ │ ├── npm-owner.mdx │ │ │ ├── npm-pack.mdx │ │ │ ├── npm-ping.mdx │ │ │ ├── npm-pkg.mdx │ │ │ ├── npm-prefix.mdx │ │ │ ├── npm-profile.mdx │ │ │ ├── npm-prune.mdx │ │ │ ├── npm-publish.mdx │ │ │ ├── npm-query.mdx │ │ │ ├── npm-rebuild.mdx │ │ │ ├── npm-repo.mdx │ │ │ ├── npm-restart.mdx │ │ │ ├── npm-root.mdx │ │ │ ├── npm-run-script.mdx │ │ │ ├── npm-sbom.mdx │ │ │ ├── npm-search.mdx │ │ │ ├── npm-shrinkwrap.mdx │ │ │ ├── npm-star.mdx │ │ │ ├── npm-stars.mdx │ │ │ ├── npm-start.mdx │ │ │ ├── npm-stop.mdx │ │ │ ├── npm-team.mdx │ │ │ ├── npm-test.mdx │ │ │ ├── npm-token.mdx │ │ │ ├── npm-uninstall.mdx │ │ │ ├── npm-unpublish.mdx │ │ │ ├── npm-unstar.mdx │ │ │ ├── npm-update.mdx │ │ │ ├── npm-version.mdx │ │ │ ├── npm-view.mdx │ │ │ ├── npm-whoami.mdx │ │ │ ├── npm.mdx │ │ │ └── npx.mdx │ │ ├── configuring-npm │ │ │ ├── folders.mdx │ │ │ ├── index.mdx │ │ │ ├── install.mdx │ │ │ ├── npm-shrinkwrap-json.mdx │ │ │ ├── npmrc.mdx │ │ │ ├── package-json.mdx │ │ │ └── package-lock-json.mdx │ │ ├── index.mdx │ │ └── using-npm │ │ │ ├── changelog.mdx │ │ │ ├── config.mdx │ │ │ ├── dependency-selectors.mdx │ │ │ ├── developers.mdx │ │ │ ├── index.mdx │ │ │ ├── logging.mdx │ │ │ ├── orgs.mdx │ │ │ ├── package-spec.mdx │ │ │ ├── registry.mdx │ │ │ ├── removal.mdx │ │ │ ├── scope.mdx │ │ │ ├── scripts.mdx │ │ │ └── workspaces.mdx │ ├── v11 │ │ ├── commands │ │ │ ├── index.mdx │ │ │ ├── npm-access.mdx │ │ │ ├── npm-adduser.mdx │ │ │ ├── npm-audit.mdx │ │ │ ├── npm-bugs.mdx │ │ │ ├── npm-cache.mdx │ │ │ ├── npm-ci.mdx │ │ │ ├── npm-completion.mdx │ │ │ ├── npm-config.mdx │ │ │ ├── npm-dedupe.mdx │ │ │ ├── npm-deprecate.mdx │ │ │ ├── npm-diff.mdx │ │ │ ├── npm-dist-tag.mdx │ │ │ ├── npm-docs.mdx │ │ │ ├── npm-doctor.mdx │ │ │ ├── npm-edit.mdx │ │ │ ├── npm-exec.mdx │ │ │ ├── npm-explain.mdx │ │ │ ├── npm-explore.mdx │ │ │ ├── npm-find-dupes.mdx │ │ │ ├── npm-fund.mdx │ │ │ ├── npm-help-search.mdx │ │ │ ├── npm-help.mdx │ │ │ ├── npm-init.mdx │ │ │ ├── npm-install-ci-test.mdx │ │ │ ├── npm-install-test.mdx │ │ │ ├── npm-install.mdx │ │ │ ├── npm-link.mdx │ │ │ ├── npm-login.mdx │ │ │ ├── npm-logout.mdx │ │ │ ├── npm-ls.mdx │ │ │ ├── npm-org.mdx │ │ │ ├── npm-outdated.mdx │ │ │ ├── npm-owner.mdx │ │ │ ├── npm-pack.mdx │ │ │ ├── npm-ping.mdx │ │ │ ├── npm-pkg.mdx │ │ │ ├── npm-prefix.mdx │ │ │ ├── npm-profile.mdx │ │ │ ├── npm-prune.mdx │ │ │ ├── npm-publish.mdx │ │ │ ├── npm-query.mdx │ │ │ ├── npm-rebuild.mdx │ │ │ ├── npm-repo.mdx │ │ │ ├── npm-restart.mdx │ │ │ ├── npm-root.mdx │ │ │ ├── npm-run.mdx │ │ │ ├── npm-sbom.mdx │ │ │ ├── npm-search.mdx │ │ │ ├── npm-shrinkwrap.mdx │ │ │ ├── npm-star.mdx │ │ │ ├── npm-stars.mdx │ │ │ ├── npm-start.mdx │ │ │ ├── npm-stop.mdx │ │ │ ├── npm-team.mdx │ │ │ ├── npm-test.mdx │ │ │ ├── npm-token.mdx │ │ │ ├── npm-undeprecate.mdx │ │ │ ├── npm-uninstall.mdx │ │ │ ├── npm-unpublish.mdx │ │ │ ├── npm-unstar.mdx │ │ │ ├── npm-update.mdx │ │ │ ├── npm-version.mdx │ │ │ ├── npm-view.mdx │ │ │ ├── npm-whoami.mdx │ │ │ ├── npm.mdx │ │ │ └── npx.mdx │ │ ├── configuring-npm │ │ │ ├── folders.mdx │ │ │ ├── index.mdx │ │ │ ├── install.mdx │ │ │ ├── npm-shrinkwrap-json.mdx │ │ │ ├── npmrc.mdx │ │ │ ├── package-json.mdx │ │ │ └── package-lock-json.mdx │ │ ├── index.mdx │ │ └── using-npm │ │ │ ├── changelog.mdx │ │ │ ├── config.mdx │ │ │ ├── dependency-selectors.mdx │ │ │ ├── developers.mdx │ │ │ ├── index.mdx │ │ │ ├── logging.mdx │ │ │ ├── orgs.mdx │ │ │ ├── package-spec.mdx │ │ │ ├── registry.mdx │ │ │ ├── removal.mdx │ │ │ ├── scope.mdx │ │ │ ├── scripts.mdx │ │ │ └── workspaces.mdx │ ├── v6 │ │ ├── commands │ │ │ ├── index.mdx │ │ │ ├── npm-access.mdx │ │ │ ├── npm-adduser.mdx │ │ │ ├── npm-audit.mdx │ │ │ ├── npm-bin.mdx │ │ │ ├── npm-bugs.mdx │ │ │ ├── npm-build.mdx │ │ │ ├── npm-bundle.mdx │ │ │ ├── npm-cache.mdx │ │ │ ├── npm-ci.mdx │ │ │ ├── npm-completion.mdx │ │ │ ├── npm-config.mdx │ │ │ ├── npm-dedupe.mdx │ │ │ ├── npm-deprecate.mdx │ │ │ ├── npm-dist-tag.mdx │ │ │ ├── npm-docs.mdx │ │ │ ├── npm-doctor.mdx │ │ │ ├── npm-edit.mdx │ │ │ ├── npm-explore.mdx │ │ │ ├── npm-fund.mdx │ │ │ ├── npm-help-search.mdx │ │ │ ├── npm-help.mdx │ │ │ ├── npm-hook.mdx │ │ │ ├── npm-init.mdx │ │ │ ├── npm-install-ci-test.mdx │ │ │ ├── npm-install-test.mdx │ │ │ ├── npm-install.mdx │ │ │ ├── npm-link.mdx │ │ │ ├── npm-logout.mdx │ │ │ ├── npm-ls.mdx │ │ │ ├── npm-org.mdx │ │ │ ├── npm-outdated.mdx │ │ │ ├── npm-owner.mdx │ │ │ ├── npm-pack.mdx │ │ │ ├── npm-ping.mdx │ │ │ ├── npm-prefix.mdx │ │ │ ├── npm-profile.mdx │ │ │ ├── npm-prune.mdx │ │ │ ├── npm-publish.mdx │ │ │ ├── npm-rebuild.mdx │ │ │ ├── npm-repo.mdx │ │ │ ├── npm-restart.mdx │ │ │ ├── npm-root.mdx │ │ │ ├── npm-run-script.mdx │ │ │ ├── npm-search.mdx │ │ │ ├── npm-shrinkwrap.mdx │ │ │ ├── npm-star.mdx │ │ │ ├── npm-stars.mdx │ │ │ ├── npm-start.mdx │ │ │ ├── npm-stop.mdx │ │ │ ├── npm-team.mdx │ │ │ ├── npm-test.mdx │ │ │ ├── npm-token.mdx │ │ │ ├── npm-uninstall.mdx │ │ │ ├── npm-unpublish.mdx │ │ │ ├── npm-update.mdx │ │ │ ├── npm-version.mdx │ │ │ ├── npm-view.mdx │ │ │ ├── npm-whoami.mdx │ │ │ └── npm.mdx │ │ ├── configuring-npm │ │ │ ├── folders.mdx │ │ │ ├── index.mdx │ │ │ ├── install.mdx │ │ │ ├── npmrc.mdx │ │ │ ├── package-json.mdx │ │ │ ├── package-lock-json.mdx │ │ │ ├── package-locks.mdx │ │ │ └── shrinkwrap-json.mdx │ │ ├── index.mdx │ │ └── using-npm │ │ │ ├── changelog.mdx │ │ │ ├── config.mdx │ │ │ ├── developers.mdx │ │ │ ├── index.mdx │ │ │ ├── orgs.mdx │ │ │ ├── registry.mdx │ │ │ ├── removal.mdx │ │ │ ├── scope.mdx │ │ │ ├── scripts.mdx │ │ │ └── semver.mdx │ ├── v7 │ │ ├── commands │ │ │ ├── index.mdx │ │ │ ├── npm-access.mdx │ │ │ ├── npm-adduser.mdx │ │ │ ├── npm-audit.mdx │ │ │ ├── npm-bin.mdx │ │ │ ├── npm-bugs.mdx │ │ │ ├── npm-cache.mdx │ │ │ ├── npm-ci.mdx │ │ │ ├── npm-completion.mdx │ │ │ ├── npm-config.mdx │ │ │ ├── npm-dedupe.mdx │ │ │ ├── npm-deprecate.mdx │ │ │ ├── npm-diff.mdx │ │ │ ├── npm-dist-tag.mdx │ │ │ ├── npm-docs.mdx │ │ │ ├── npm-doctor.mdx │ │ │ ├── npm-edit.mdx │ │ │ ├── npm-exec.mdx │ │ │ ├── npm-explain.mdx │ │ │ ├── npm-explore.mdx │ │ │ ├── npm-find-dupes.mdx │ │ │ ├── npm-fund.mdx │ │ │ ├── npm-help-search.mdx │ │ │ ├── npm-help.mdx │ │ │ ├── npm-hook.mdx │ │ │ ├── npm-init.mdx │ │ │ ├── npm-install-ci-test.mdx │ │ │ ├── npm-install-test.mdx │ │ │ ├── npm-install.mdx │ │ │ ├── npm-link.mdx │ │ │ ├── npm-logout.mdx │ │ │ ├── npm-ls.mdx │ │ │ ├── npm-org.mdx │ │ │ ├── npm-outdated.mdx │ │ │ ├── npm-owner.mdx │ │ │ ├── npm-pack.mdx │ │ │ ├── npm-ping.mdx │ │ │ ├── npm-pkg.mdx │ │ │ ├── npm-prefix.mdx │ │ │ ├── npm-profile.mdx │ │ │ ├── npm-prune.mdx │ │ │ ├── npm-publish.mdx │ │ │ ├── npm-rebuild.mdx │ │ │ ├── npm-repo.mdx │ │ │ ├── npm-restart.mdx │ │ │ ├── npm-root.mdx │ │ │ ├── npm-run-script.mdx │ │ │ ├── npm-search.mdx │ │ │ ├── npm-set-script.mdx │ │ │ ├── npm-shrinkwrap.mdx │ │ │ ├── npm-star.mdx │ │ │ ├── npm-stars.mdx │ │ │ ├── npm-start.mdx │ │ │ ├── npm-stop.mdx │ │ │ ├── npm-team.mdx │ │ │ ├── npm-test.mdx │ │ │ ├── npm-token.mdx │ │ │ ├── npm-uninstall.mdx │ │ │ ├── npm-unpublish.mdx │ │ │ ├── npm-unstar.mdx │ │ │ ├── npm-update.mdx │ │ │ ├── npm-version.mdx │ │ │ ├── npm-view.mdx │ │ │ ├── npm-whoami.mdx │ │ │ ├── npm.mdx │ │ │ └── npx.mdx │ │ ├── configuring-npm │ │ │ ├── folders.mdx │ │ │ ├── index.mdx │ │ │ ├── install.mdx │ │ │ ├── npm-shrinkwrap-json.mdx │ │ │ ├── npmrc.mdx │ │ │ ├── package-json.mdx │ │ │ └── package-lock-json.mdx │ │ ├── index.mdx │ │ └── using-npm │ │ │ ├── changelog.mdx │ │ │ ├── config.mdx │ │ │ ├── developers.mdx │ │ │ ├── index.mdx │ │ │ ├── orgs.mdx │ │ │ ├── registry.mdx │ │ │ ├── removal.mdx │ │ │ ├── scope.mdx │ │ │ ├── scripts.mdx │ │ │ └── workspaces.mdx │ ├── v8 │ │ ├── commands │ │ │ ├── index.mdx │ │ │ ├── npm-access.mdx │ │ │ ├── npm-adduser.mdx │ │ │ ├── npm-audit.mdx │ │ │ ├── npm-bin.mdx │ │ │ ├── npm-bugs.mdx │ │ │ ├── npm-cache.mdx │ │ │ ├── npm-ci.mdx │ │ │ ├── npm-completion.mdx │ │ │ ├── npm-config.mdx │ │ │ ├── npm-dedupe.mdx │ │ │ ├── npm-deprecate.mdx │ │ │ ├── npm-diff.mdx │ │ │ ├── npm-dist-tag.mdx │ │ │ ├── npm-docs.mdx │ │ │ ├── npm-doctor.mdx │ │ │ ├── npm-edit.mdx │ │ │ ├── npm-exec.mdx │ │ │ ├── npm-explain.mdx │ │ │ ├── npm-explore.mdx │ │ │ ├── npm-find-dupes.mdx │ │ │ ├── npm-fund.mdx │ │ │ ├── npm-help-search.mdx │ │ │ ├── npm-help.mdx │ │ │ ├── npm-hook.mdx │ │ │ ├── npm-init.mdx │ │ │ ├── npm-install-ci-test.mdx │ │ │ ├── npm-install-test.mdx │ │ │ ├── npm-install.mdx │ │ │ ├── npm-link.mdx │ │ │ ├── npm-logout.mdx │ │ │ ├── npm-ls.mdx │ │ │ ├── npm-org.mdx │ │ │ ├── npm-outdated.mdx │ │ │ ├── npm-owner.mdx │ │ │ ├── npm-pack.mdx │ │ │ ├── npm-ping.mdx │ │ │ ├── npm-pkg.mdx │ │ │ ├── npm-prefix.mdx │ │ │ ├── npm-profile.mdx │ │ │ ├── npm-prune.mdx │ │ │ ├── npm-publish.mdx │ │ │ ├── npm-query.mdx │ │ │ ├── npm-rebuild.mdx │ │ │ ├── npm-repo.mdx │ │ │ ├── npm-restart.mdx │ │ │ ├── npm-root.mdx │ │ │ ├── npm-run-script.mdx │ │ │ ├── npm-search.mdx │ │ │ ├── npm-set-script.mdx │ │ │ ├── npm-shrinkwrap.mdx │ │ │ ├── npm-star.mdx │ │ │ ├── npm-stars.mdx │ │ │ ├── npm-start.mdx │ │ │ ├── npm-stop.mdx │ │ │ ├── npm-team.mdx │ │ │ ├── npm-test.mdx │ │ │ ├── npm-token.mdx │ │ │ ├── npm-uninstall.mdx │ │ │ ├── npm-unpublish.mdx │ │ │ ├── npm-unstar.mdx │ │ │ ├── npm-update.mdx │ │ │ ├── npm-version.mdx │ │ │ ├── npm-view.mdx │ │ │ ├── npm-whoami.mdx │ │ │ ├── npm.mdx │ │ │ └── npx.mdx │ │ ├── configuring-npm │ │ │ ├── folders.mdx │ │ │ ├── index.mdx │ │ │ ├── install.mdx │ │ │ ├── npm-shrinkwrap-json.mdx │ │ │ ├── npmrc.mdx │ │ │ ├── package-json.mdx │ │ │ └── package-lock-json.mdx │ │ ├── index.mdx │ │ └── using-npm │ │ │ ├── changelog.mdx │ │ │ ├── config.mdx │ │ │ ├── dependency-selectors.mdx │ │ │ ├── developers.mdx │ │ │ ├── index.mdx │ │ │ ├── logging.mdx │ │ │ ├── orgs.mdx │ │ │ ├── package-spec.mdx │ │ │ ├── registry.mdx │ │ │ ├── removal.mdx │ │ │ ├── scope.mdx │ │ │ ├── scripts.mdx │ │ │ └── workspaces.mdx │ └── v9 │ │ ├── commands │ │ ├── index.mdx │ │ ├── npm-access.mdx │ │ ├── npm-adduser.mdx │ │ ├── npm-audit.mdx │ │ ├── npm-bugs.mdx │ │ ├── npm-cache.mdx │ │ ├── npm-ci.mdx │ │ ├── npm-completion.mdx │ │ ├── npm-config.mdx │ │ ├── npm-dedupe.mdx │ │ ├── npm-deprecate.mdx │ │ ├── npm-diff.mdx │ │ ├── npm-dist-tag.mdx │ │ ├── npm-docs.mdx │ │ ├── npm-doctor.mdx │ │ ├── npm-edit.mdx │ │ ├── npm-exec.mdx │ │ ├── npm-explain.mdx │ │ ├── npm-explore.mdx │ │ ├── npm-find-dupes.mdx │ │ ├── npm-fund.mdx │ │ ├── npm-help-search.mdx │ │ ├── npm-help.mdx │ │ ├── npm-hook.mdx │ │ ├── npm-init.mdx │ │ ├── npm-install-ci-test.mdx │ │ ├── npm-install-test.mdx │ │ ├── npm-install.mdx │ │ ├── npm-link.mdx │ │ ├── npm-login.mdx │ │ ├── npm-logout.mdx │ │ ├── npm-ls.mdx │ │ ├── npm-org.mdx │ │ ├── npm-outdated.mdx │ │ ├── npm-owner.mdx │ │ ├── npm-pack.mdx │ │ ├── npm-ping.mdx │ │ ├── npm-pkg.mdx │ │ ├── npm-prefix.mdx │ │ ├── npm-profile.mdx │ │ ├── npm-prune.mdx │ │ ├── npm-publish.mdx │ │ ├── npm-query.mdx │ │ ├── npm-rebuild.mdx │ │ ├── npm-repo.mdx │ │ ├── npm-restart.mdx │ │ ├── npm-root.mdx │ │ ├── npm-run-script.mdx │ │ ├── npm-sbom.mdx │ │ ├── npm-search.mdx │ │ ├── npm-shrinkwrap.mdx │ │ ├── npm-star.mdx │ │ ├── npm-stars.mdx │ │ ├── npm-start.mdx │ │ ├── npm-stop.mdx │ │ ├── npm-team.mdx │ │ ├── npm-test.mdx │ │ ├── npm-token.mdx │ │ ├── npm-uninstall.mdx │ │ ├── npm-unpublish.mdx │ │ ├── npm-unstar.mdx │ │ ├── npm-update.mdx │ │ ├── npm-version.mdx │ │ ├── npm-view.mdx │ │ ├── npm-whoami.mdx │ │ ├── npm.mdx │ │ └── npx.mdx │ │ ├── configuring-npm │ │ ├── folders.mdx │ │ ├── index.mdx │ │ ├── install.mdx │ │ ├── npm-shrinkwrap-json.mdx │ │ ├── npmrc.mdx │ │ ├── package-json.mdx │ │ └── package-lock-json.mdx │ │ ├── index.mdx │ │ └── using-npm │ │ ├── changelog.mdx │ │ ├── config.mdx │ │ ├── dependency-selectors.mdx │ │ ├── developers.mdx │ │ ├── index.mdx │ │ ├── logging.mdx │ │ ├── orgs.mdx │ │ ├── package-spec.mdx │ │ ├── registry.mdx │ │ ├── removal.mdx │ │ ├── scope.mdx │ │ ├── scripts.mdx │ │ └── workspaces.mdx ├── enterprise │ └── index.mdx ├── getting-started │ ├── configuring-your-local-environment │ │ ├── about-npm-versions.mdx │ │ ├── downloading-and-installing-node-js-and-npm.mdx │ │ └── index.mdx │ ├── index.mdx │ ├── managing-your-npm-user-account │ │ ├── changing-your-npm-username.mdx │ │ ├── deleting-your-npm-user-account.mdx │ │ ├── index.mdx │ │ ├── managing-your-profile-settings.mdx │ │ └── requesting-your-data.mdx │ ├── paying-for-your-npm-user-account │ │ ├── downgrading-to-a-free-user-account-plan.mdx │ │ ├── index.mdx │ │ ├── updating-user-account-billing-settings.mdx │ │ ├── upgrading-to-a-paid-user-account-plan.mdx │ │ └── viewing-downloading-and-emailing-receipts-for-your-user-account.mdx │ ├── setting-up-your-npm-user-account │ │ ├── about-two-factor-authentication.mdx │ │ ├── accessing-npm-using-2fa.mdx │ │ ├── configuring-two-factor-authentication.mdx │ │ ├── creating-a-new-npm-user-account.mdx │ │ ├── creating-a-strong-password.mdx │ │ ├── index.mdx │ │ ├── receiving-a-one-time-password-over-email.mdx │ │ └── recovering-your-2fa-enabled-account.mdx │ └── troubleshooting │ │ ├── common-errors.mdx │ │ ├── generating-and-locating-npm-debug.log-files.mdx │ │ ├── index.mdx │ │ ├── try-the-latest-stable-version-of-node.mdx │ │ └── try-the-latest-stable-version-of-npm.mdx ├── header-nav.yml ├── index.mdx ├── integrations │ ├── index.mdx │ └── integrating-npm-with-external-services │ │ ├── about-access-tokens.mdx │ │ ├── creating-and-viewing-access-tokens.mdx │ │ ├── docker-and-private-modules.mdx │ │ ├── index.mdx │ │ ├── revoking-access-tokens.mdx │ │ └── using-private-packages-in-a-ci-cd-workflow.mdx ├── nav.yml ├── organizations │ ├── creating-and-managing-organizations │ │ ├── converting-your-user-account-to-an-organization.mdx │ │ ├── creating-an-organization.mdx │ │ ├── deleting-an-organization.mdx │ │ ├── index.mdx │ │ ├── renaming-an-organization.mdx │ │ └── requiring-two-factor-authentication-in-your-organization.mdx │ ├── index.mdx │ ├── managing-organization-members │ │ ├── accepting-or-rejecting-an-organization-invitation.mdx │ │ ├── adding-members-to-your-organization.mdx │ │ ├── index.mdx │ │ ├── managing-organization-permissions.mdx │ │ ├── organization-roles-and-permissions.mdx │ │ └── removing-members-from-your-organization.mdx │ ├── managing-organization-packages │ │ ├── about-organization-scopes-and-packages.mdx │ │ ├── configuring-your-npm-client-with-your-organization-settings.mdx │ │ ├── creating-and-publishing-an-organization-scoped-package.mdx │ │ └── index.mdx │ ├── managing-teams │ │ ├── about-developers-team.mdx │ │ ├── adding-organization-members-to-teams.mdx │ │ ├── creating-teams.mdx │ │ ├── index.mdx │ │ ├── managing-team-access-to-organization-packages.mdx │ │ ├── removing-organization-members-from-teams.mdx │ │ └── removing-teams.mdx │ └── paying-for-your-organization │ │ ├── downgrading-to-a-free-organization-plan.mdx │ │ ├── index.mdx │ │ ├── updating-organization-billing-settings.mdx │ │ ├── upgrading-to-a-paid-organization-plan.mdx │ │ └── viewing-downloading-and-emailing-receipts-for-your-organization.mdx ├── packages-and-modules │ ├── contributing-packages-to-the-registry │ │ ├── about-package-readme-files.mdx │ │ ├── about-semantic-versioning.mdx │ │ ├── adding-dist-tags-to-packages.mdx │ │ ├── creating-a-package-json-file.mdx │ │ ├── creating-and-publishing-private-packages.mdx │ │ ├── creating-and-publishing-scoped-public-packages.mdx │ │ ├── creating-and-publishing-unscoped-public-packages.mdx │ │ ├── creating-node-js-modules.mdx │ │ ├── index.mdx │ │ ├── package-name-guidelines.mdx │ │ └── specifying-dependencies-and-devdependencies-in-a-package-json-file.mdx │ ├── getting-packages-from-the-registry │ │ ├── downloading-and-installing-packages-globally.mdx │ │ ├── downloading-and-installing-packages-locally.mdx │ │ ├── index.mdx │ │ ├── resolving-eacces-permissions-errors-when-installing-packages-globally.mdx │ │ ├── searching-for-and-choosing-packages-to-download.mdx │ │ ├── uninstalling-packages-and-dependencies.mdx │ │ ├── updating-packages-downloaded-from-the-registry.mdx │ │ ├── using-deprecated-packages.mdx │ │ ├── using-npm-packages-in-your-projects.mdx │ │ └── viewing-package-provenance.mdx │ ├── index.mdx │ ├── introduction-to-packages-and-modules │ │ ├── about-packages-and-modules.mdx │ │ ├── about-private-packages.mdx │ │ ├── about-public-packages.mdx │ │ ├── about-scopes.mdx │ │ ├── about-the-public-npm-registry.mdx │ │ ├── index.mdx │ │ └── package-scope-access-level-and-visibility.mdx │ ├── securing-your-code │ │ ├── about-audit-reports.mdx │ │ ├── about-registry-signatures.mdx │ │ ├── auditing-package-dependencies-for-security-vulnerabilities.mdx │ │ ├── generating-provenance-statements.mdx │ │ ├── index.mdx │ │ ├── reporting-malware-in-an-npm-package.mdx │ │ ├── requiring-2fa-for-package-publishing-and-settings-modification.mdx │ │ └── verifying-registry-signatures.mdx │ └── updating-and-managing-your-published-packages │ │ ├── adding-collaborators-to-private-packages-owned-by-a-user-account.mdx │ │ ├── changing-package-visibility.mdx │ │ ├── deprecating-and-undeprecating-packages-or-package-versions.mdx │ │ ├── index.mdx │ │ ├── transferring-a-package-from-a-user-account-to-another-user-account.mdx │ │ ├── unpublishing-packages-from-the-registry.mdx │ │ └── updating-your-published-package-version-number.mdx ├── policies │ ├── conduct.mdx │ ├── crawlers.mdx │ ├── disputes.mdx │ ├── dmca.mdx │ ├── index.mdx │ ├── logos-and-usage.mdx │ ├── npm-license.mdx │ ├── open-source-terms.mdx │ ├── orgs-plan.mdx │ ├── privacy.mdx │ ├── private-terms.mdx │ ├── security.mdx │ ├── solo-plan.mdx │ ├── terms.mdx │ └── unpublish.mdx └── threats-and-mitigations │ └── index.mdx ├── gatsby-browser.js ├── gatsby-config.mjs ├── gatsby-node.mjs ├── gatsby-ssr.js ├── jest-preprocess.js ├── jest-setup.js ├── jest.config.js ├── package-lock.json ├── package.json ├── scripts └── template-oss │ ├── _step-deps-yml.hbs │ ├── _step-lint-yml.hbs │ ├── ci-yml.hbs │ ├── dependabot-yml.hbs │ ├── index.js │ ├── package-json.hbs │ └── publish-yml.hbs ├── src ├── components │ ├── __tests__ │ │ └── page-footer.test.js │ ├── breadcrumbs.js │ ├── header.js │ ├── link.js │ ├── nav-drawer.js │ ├── nav-items.js │ ├── page-footer.js │ ├── search.js │ ├── sidebar.js │ ├── site-title.js │ ├── skip-nav.js │ ├── table-of-contents.js │ ├── text-input.js │ ├── variant-select.js │ └── visually-hidden.js ├── constants.js ├── favicon.png ├── head.js ├── hooks │ ├── use-breakpoint.js │ ├── use-location-change.js │ ├── use-page.js │ ├── use-search.js │ └── use-site-metadata.js ├── layout.js ├── mdx │ ├── code.js │ ├── components.js │ ├── index.js │ └── nav-hierarchy.js ├── page.js ├── root.js ├── shared.js ├── theme.js └── util │ ├── aria-live.js │ ├── get-nav.js │ ├── omit.js │ └── search.worker.js ├── static ├── enterprise │ ├── setup-and-configuration │ │ ├── acknowledge-blocking.png │ │ ├── sso-configure.png │ │ ├── sso-save.png │ │ └── sso-settings-form.png │ └── user-management │ │ ├── activate-user.png │ │ ├── deactivate-user.png │ │ └── manage-users.png ├── getting-started │ ├── managing-your-npm-user-account │ │ ├── account-deletion-confirmation.png │ │ ├── connect-github.png │ │ ├── connect-twitter.png │ │ ├── delete-your-account.png │ │ ├── github-authorize.png │ │ ├── github-disconnect.png │ │ ├── github-login.png │ │ ├── github-remove.png │ │ ├── github-success.png │ │ ├── profile-settings-cli.png │ │ ├── requesting-your-data.png │ │ ├── twitter-authorize.png │ │ ├── twitter-disconnect.png │ │ ├── twitter-login.png │ │ ├── twitter-remove.png │ │ └── twitter-success.png │ ├── paying-for-your-npm-user-account │ │ ├── billing-upgrade-button.png │ │ ├── billing-upgrade-form.png │ │ ├── change-plan.png │ │ └── enable-private-publishing.png │ └── setting-up-your-npm-user-account │ │ ├── 2fa-add-security-key.png │ │ ├── 2fa-auth-pub-select.png │ │ ├── 2fa-disable-submit.png │ │ ├── 2fa-disable.png │ │ ├── 2fa-enable.png │ │ ├── 2fa-modify.png │ │ ├── 2fa-use-security-key.png │ │ ├── 2fa-verify.png │ │ ├── cli-login-screen.png │ │ ├── create-account-button.png │ │ ├── device-selection.png │ │ ├── disable-2fa-button.png │ │ ├── email-otp-code.png │ │ ├── go-back-to-settings.png │ │ ├── link-github-account.png │ │ ├── link-twitter-account.png │ │ ├── lost-recovery-code.png │ │ ├── one-time-password-email.png │ │ ├── open-support-ticket.png │ │ ├── privacy-policy.png │ │ ├── recover-account.png │ │ ├── recovery-code-link.png │ │ ├── recovery-code.png │ │ ├── request-account-recovery.png │ │ ├── signin-screen.png │ │ ├── signup-form.png │ │ ├── touch-id-mac-edge.png │ │ ├── user-a-recovery-code.png │ │ ├── view-recovery-codes.png │ │ └── webauthn-cli-login-token.png ├── integrations │ └── integrating-npm-with-external-services │ │ ├── create-token.png │ │ ├── granular-access-token-ip-range.png │ │ ├── granular-access-token-organizations.png │ │ ├── granular-access-token-packages-scopes.png │ │ ├── granular-access-token-summary.png │ │ ├── token-level-select.png │ │ └── tokens-profile.png ├── organizations │ ├── creating-and-managing-organizations │ │ ├── convert-confirmation.png │ │ ├── convert-from-user.png │ │ ├── convert-new-username.png │ │ ├── create-confirm.png │ │ ├── create-invite.png │ │ ├── create-name.png │ │ ├── left-sidebar.png │ │ ├── org-delete-button.png │ │ └── org-delete-plan.png │ ├── managing-organization-members │ │ ├── accept-invitation.png │ │ ├── change-member-role.png │ │ ├── invite-button.png │ │ ├── invite-members-button.png │ │ ├── remove-member.png │ │ ├── revoke-invitation.png │ │ └── username-or-email-field.png │ ├── managing-teams │ │ ├── team-creation-confirmation.png │ │ ├── team-member-add-button.png │ │ ├── team-member-remove-button.png │ │ ├── team-member-select.png │ │ ├── team-members.png │ │ ├── team-name-description.png │ │ ├── team-package-add-existing-button.png │ │ ├── team-package-change-permissions.png │ │ ├── team-package-permissions.png │ │ ├── team-package-remove-button.png │ │ ├── team-package-select.png │ │ ├── team-packages-button.png │ │ └── team-remove.png │ └── requiring-two-factor-authentication-in-your-organization │ │ ├── enable-2fa.png │ │ └── removal-confirmation.png ├── packages-and-modules │ ├── deleting-deprecating │ │ ├── delete-package-confirm.png │ │ ├── delete-package-settings.png │ │ ├── deprecate-package-confirm.png │ │ └── deprecate-package-settings.png │ ├── getting-packages-from-the-registry │ │ ├── npm-provenance-check-mark.png │ │ ├── npm-provenance-unreachable-source-commit@2x.png │ │ ├── npm-provenance.png │ │ ├── package-deprecated.png │ │ ├── search-results.png │ │ ├── search-sort-options.png │ │ └── search-suggestions.png │ ├── securing-your-code │ │ ├── 2fa-package-admin.png │ │ ├── 2fa-package-disable.png │ │ ├── 2fa-package-require.png │ │ ├── 2fa-package-setting.png │ │ ├── 2fa-package-turnoff.png │ │ ├── 2fa-package-update.png │ │ ├── audit-manual-review.png │ │ ├── audit-no-vulnerabilities.png │ │ ├── audit-report-results.png │ │ └── audit-report-suggested-fixes.png │ └── updating-and-managing-your-published-packages │ │ ├── deprecate-package.png │ │ ├── deprecate-version.png │ │ ├── package-maintainer-invite.png │ │ └── package-maintainer-list.png └── shared │ ├── account-settings.png │ ├── billing-creditcard-form.png │ ├── billing-downgrade-confirm.png │ ├── billing-downgrade-selection.png │ ├── billing-download-checked.png │ ├── billing-download-icon.png │ ├── billing-email-checked.png │ ├── billing-email-icon.png │ ├── billing-email-receipt.png │ ├── billing-extra-info.png │ ├── billing-extra-receipt-email.png │ ├── billing-extra-save.png │ ├── billing-form.png │ ├── billing-history.png │ ├── billing-info.png │ ├── billing-plan-selection.png │ ├── billing-receipt-settings.png │ ├── billing-update-card.png │ ├── billing-view-icon.png │ ├── enterprise-activate-user.png │ ├── enterprise-admin-panel-settings.png │ ├── enterprise-admin-panel.png │ ├── enterprise-admin-profile-menu.png │ ├── enterprise-choose-security-policy.png │ ├── enterprise-custom-blocking-message.png │ ├── enterprise-deactivate-user-button.png │ ├── enterprise-manage-users-button.png │ ├── enterprise-sso-configure.png │ ├── enterprise-sso-save-button.png │ ├── enterprise-sso-settings-form.png │ ├── organization-billing-tab.png │ ├── organization-create.png │ ├── organization-members-tab.png │ ├── organization-package-private.png │ ├── organization-package-public.png │ ├── organization-selection.png │ ├── organization-teams-tab.png │ ├── payment-info-button.png │ ├── payment-info.png │ ├── payment-remember-me.png │ ├── profile-settings.png │ └── user-login.png └── webpack.config.js /.eslint.config.js: -------------------------------------------------------------------------------- 1 | import github from 'eslint-plugin-github' 2 | 3 | export default [ 4 | github.getFlatConfigs().react, 5 | { 6 | // This lets your .eslintrc.js handle most configuration 7 | ignores: ['.cache/**', 'public/**'], 8 | }, 9 | ] 10 | -------------------------------------------------------------------------------- /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @npm/cli-team 2 | 3 | # Content 4 | /.github/CODEOWNERS @leobalter @monishcm @wraithgar 5 | /content/ @leobalter @monishcm @wraithgar 6 | /src/ @leobalter @monishcm @wraithgar 7 | /static/ @leobalter @monishcm @wraithgar 8 | /CONTENT-MODEL.md @leobalter @monishcm @wraithgar 9 | 10 | # Policies 11 | /content/policies/ @leobalter 12 | /CODE_OF_CONDUCT.md @leobalter 13 | 14 | # Licensing 15 | /.reuse/ @leobalter @wraithgar 16 | /LICENSES/ @leobalter 17 | /LICENSE @leobalter 18 | /LICENSE-CODE @leobalter 19 | 20 | # CLI 21 | /content/cli/ @npm/cli-team 22 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | # This file is automatically added by @npmcli/template-oss. Do not edit. 2 | 3 | blank_issues_enabled: true 4 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | # This file is automatically added by @npmcli/template-oss. Do not edit. 2 | 3 | version: 2 4 | 5 | updates: 6 | - package-ecosystem: npm 7 | directory: / 8 | schedule: 9 | interval: daily 10 | target-branch: "main" 11 | allow: 12 | - dependency-type: direct 13 | versioning-strategy: increase-if-necessary 14 | commit-message: 15 | prefix: deps 16 | prefix-development: chore 17 | labels: 18 | - "Dependencies" 19 | open-pull-requests-limit: 10 20 | groups: 21 | dependency-updates: 22 | applies-to: version-updates 23 | patterns: 24 | - "*" 25 | update-types: 26 | - "minor" 27 | - "patch" 28 | -------------------------------------------------------------------------------- /.github/matchers/tap.json: -------------------------------------------------------------------------------- 1 | { 2 | "//@npmcli/template-oss": "This file is automatically added by @npmcli/template-oss. Do not edit.", 3 | "problemMatcher": [ 4 | { 5 | "owner": "tap", 6 | "pattern": [ 7 | { 8 | "regexp": "^\\s*not ok \\d+ - (.*)", 9 | "message": 1 10 | }, 11 | { 12 | "regexp": "^\\s*---" 13 | }, 14 | { 15 | "regexp": "^\\s*at:" 16 | }, 17 | { 18 | "regexp": "^\\s*line:\\s*(\\d+)", 19 | "line": 1 20 | }, 21 | { 22 | "regexp": "^\\s*column:\\s*(\\d+)", 23 | "column": 1 24 | }, 25 | { 26 | "regexp": "^\\s*file:\\s*(.*)", 27 | "file": 1 28 | } 29 | ] 30 | } 31 | ] 32 | } 33 | -------------------------------------------------------------------------------- /.github/workflows/audit.yml: -------------------------------------------------------------------------------- 1 | # This file is automatically added by @npmcli/template-oss. Do not edit. 2 | 3 | name: Audit 4 | 5 | on: 6 | workflow_dispatch: 7 | schedule: 8 | # "At 08:00 UTC (01:00 PT) on Monday" https://crontab.guru/#0_8_*_*_1 9 | - cron: "0 8 * * 1" 10 | 11 | permissions: 12 | contents: read 13 | 14 | jobs: 15 | audit: 16 | name: Audit Dependencies 17 | if: github.repository_owner == 'npm' 18 | runs-on: ubuntu-latest 19 | defaults: 20 | run: 21 | shell: bash 22 | steps: 23 | - name: Checkout 24 | uses: actions/checkout@v4 25 | - name: Setup Git User 26 | run: | 27 | git config --global user.email "npm-cli+bot@github.com" 28 | git config --global user.name "npm CLI robot" 29 | - name: Setup Node 30 | uses: actions/setup-node@v4 31 | id: node 32 | with: 33 | node-version: 22.x 34 | check-latest: contains('22.x', '.x') 35 | cache: npm 36 | - name: Install Latest npm 37 | uses: ./.github/actions/install-latest-npm 38 | with: 39 | node: ${{ steps.node.outputs.node-version }} 40 | - name: Install Dependencies 41 | run: npm i --no-audit --no-fund --package-lock 42 | - name: Run Production Audit 43 | run: npm audit --omit=dev 44 | - name: Run Full Audit 45 | run: npm audit --audit-level=none 46 | -------------------------------------------------------------------------------- /.github/workflows/codeql-analysis.yml: -------------------------------------------------------------------------------- 1 | # This file is automatically added by @npmcli/template-oss. Do not edit. 2 | 3 | name: CodeQL 4 | 5 | on: 6 | push: 7 | branches: 8 | - main 9 | pull_request: 10 | branches: 11 | - main 12 | schedule: 13 | # "At 10:00 UTC (03:00 PT) on Monday" https://crontab.guru/#0_10_*_*_1 14 | - cron: "0 10 * * 1" 15 | 16 | permissions: 17 | contents: read 18 | 19 | jobs: 20 | analyze: 21 | name: Analyze 22 | runs-on: ubuntu-latest 23 | permissions: 24 | actions: read 25 | contents: read 26 | security-events: write 27 | steps: 28 | - name: Checkout 29 | uses: actions/checkout@v4 30 | - name: Setup Git User 31 | run: | 32 | git config --global user.email "npm-cli+bot@github.com" 33 | git config --global user.name "npm CLI robot" 34 | - name: Initialize CodeQL 35 | uses: github/codeql-action/init@v3 36 | with: 37 | languages: javascript 38 | - name: Perform CodeQL Analysis 39 | uses: github/codeql-action/analyze@v3 40 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # This file is automatically added by @npmcli/template-oss. Do not edit. 2 | 3 | # ignore everything in the root 4 | /* 5 | 6 | !**/.gitignore 7 | !/.commitlintrc.js 8 | !/.eslint.config.js 9 | !/.eslintrc.js 10 | !/.eslintrc.local.* 11 | !/.git-blame-ignore-revs 12 | !/.github/ 13 | !/.gitignore 14 | !/.npmrc 15 | !/.nvmrc 16 | !/.prettierignore 17 | !/.prettierrc.js 18 | !/.release-please-manifest.json 19 | !/.reuse/ 20 | !/bin/ 21 | !/CHANGELOG* 22 | !/CODE_OF_CONDUCT.md 23 | !/CONTENT-MODEL.md 24 | !/content/ 25 | !/CONTRIBUTING.md 26 | !/docs/ 27 | !/gatsby-* 28 | !/jest*.js 29 | !/lib/ 30 | !/LICENSE* 31 | !/map.js 32 | !/package-lock.json 33 | !/package.json 34 | !/README* 35 | !/release-please-config.json 36 | !/scripts/ 37 | !/SECURITY.md 38 | !/src 39 | !/static/ 40 | !/tap-snapshots/ 41 | !/test/ 42 | !/tsconfig.json 43 | !/webpack.config.js 44 | !cli-cache.json 45 | tap-testdir*/ 46 | !/cli/ 47 | -------------------------------------------------------------------------------- /.npmrc: -------------------------------------------------------------------------------- 1 | ; This file is automatically added by @npmcli/template-oss. Do not edit. 2 | 3 | package-lock=true 4 | legacy-peer-deps=true 5 | -------------------------------------------------------------------------------- /.nvmrc: -------------------------------------------------------------------------------- 1 | 22 2 | -------------------------------------------------------------------------------- /.prettierignore: -------------------------------------------------------------------------------- 1 | **/template-oss/*.hbs 2 | /.github/ 3 | /package-lock.json 4 | /SECURITY.md 5 | /.reuse/ 6 | .nyc_output/ 7 | coverage/ 8 | cli-cache.json -------------------------------------------------------------------------------- /.prettierrc.js: -------------------------------------------------------------------------------- 1 | const config = require('@github/prettier-config') 2 | 3 | module.exports = { 4 | ...config, 5 | proseWrap: 'never', 6 | embeddedLanguageFormatting: 'off', 7 | overrides: [ 8 | { 9 | files: ['content/**/*.mdx'], 10 | printWidth: 99999, 11 | }, 12 | ], 13 | } 14 | -------------------------------------------------------------------------------- /.reuse/dep5: -------------------------------------------------------------------------------- 1 | Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ 2 | Upstream-Name: documentation 3 | Upstream-Contact: Myles Borins 4 | Source: https://github.com/npm/documentation 5 | 6 | Files: content/* static/* 7 | Copyright: 2020 GitHub 8 | License: CC-BY-4.0 9 | 10 | Files: scripts/* cli/* theme/* src/* .github/* *.md *.js *.mjs *.json .* 11 | Copyright: 2020 GitHub 12 | License: MIT 13 | -------------------------------------------------------------------------------- /LICENSE-CODE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2020 GitHub 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /LICENSES/CC-BY-4.0.txt: -------------------------------------------------------------------------------- 1 | ../LICENSE -------------------------------------------------------------------------------- /LICENSES/MIT.txt: -------------------------------------------------------------------------------- 1 | ../LICENSE-CODE -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # npm Documentation 2 | 3 | [![Publish](https://github.com/npm/documentation/actions/workflows/publish.yml/badge.svg)](https://github.com/npm/documentation/actions/workflows/publish.yml) 4 | 5 | This is the documentation for [https://docs.npmjs.com/](https://docs.npmjs.com/). 6 | 7 | [This repository](https://github.com/npm/documentation) contains the content for our documentation site, and the GitHub Actions workflows that generate the site itself. 8 | 9 | ## Quick start 10 | 11 | 1. `npm install` to download gatsby, our theme, and the dependencies 12 | 2. `npm run develop`: starts the test server at `http://localhost:8000`. 13 | 3. Update the content - it's Mdx, which is like markdown - in the `content` directory. 14 | 4. Review your content at `http://localhost:8000`. (Gatsby watches the filesystem and will reload your content changes immediately.) 15 | 5. Once you're happy, commit it and open a pull request at https://github.com/npm/documentation. 16 | 6. A CI workflow run will publish your PR to a GitHub Preview Page. 17 | 7. Once the content is reviewed, merge the pull request. That will [deploy the site](https://github.com/npm/documentation/actions/workflows/publish.yml). 18 | 19 | Do you want to know more? Check out our [contributing guide](CONTRIBUTING.md). 20 | 21 | ## License 22 | 23 | The npm product documentation in the content, and static folders are licensed under a [CC-BY 4.0 license](LICENSE). 24 | 25 | All other code in this repository is licensed under a [MIT license](LICENSE-CODE). 26 | 27 | When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). 28 | -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | GitHub takes the security of our software products and services seriously, including the open source code repositories managed through our GitHub organizations, such as [GitHub](https://github.com/GitHub). 4 | 5 | If you believe you have found a security vulnerability in this GitHub-owned open source repository, you can report it to us in one of two ways. 6 | 7 | If the vulnerability you have found is *not* [in scope for the GitHub Bug Bounty Program](https://bounty.github.com/#scope) or if you do not wish to be considered for a bounty reward, please report the issue to us directly through [opensource-security@github.com](mailto:opensource-security@github.com). 8 | 9 | If the vulnerability you have found is [in scope for the GitHub Bug Bounty Program](https://bounty.github.com/#scope) and you would like for your finding to be considered for a bounty reward, please submit the vulnerability to us through [HackerOne](https://hackerone.com/github) in order to be eligible to receive a bounty award. 10 | 11 | **Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.** 12 | 13 | Thanks for helping make GitHub safe for everyone. 14 | -------------------------------------------------------------------------------- /cli-cache.json: -------------------------------------------------------------------------------- 1 | { 2 | "v8": "aa8fff11cdab94fff1a2160ee5241f5f4632e96b", 3 | "v9": "64763a341e7aa5b456e696f956759bf9b3440dc1", 4 | "v10": "e510f14bf6a20d67e7b37c3f25ff271d9f7a0da5", 5 | "v11": "e758dd7bec58efed2cc865a6d360b0432ccc9f57" 6 | } -------------------------------------------------------------------------------- /cli/.gitignore: -------------------------------------------------------------------------------- 1 | # This file is automatically added by @npmcli/template-oss. Do not edit. 2 | 3 | # ignore everything in the root 4 | /* 5 | 6 | !**/.gitignore 7 | !/.eslint.config.js 8 | !/.eslintrc.js 9 | !/.eslintrc.local.* 10 | !/.git-blame-ignore-revs 11 | !/.gitignore 12 | !/bin/ 13 | !/CHANGELOG* 14 | !/docs/ 15 | !/lib/ 16 | !/LICENSE* 17 | !/map.js 18 | !/package.json 19 | !/README* 20 | !/releases.json 21 | !/scripts/ 22 | !/tap-snapshots/ 23 | !/test/ 24 | tap-testdir*/ 25 | -------------------------------------------------------------------------------- /cli/lib/cache.js: -------------------------------------------------------------------------------- 1 | const fs = require('fs/promises') 2 | 3 | /** cache npm cli version shas to NOT pull down changes we already have */ 4 | class CacheVersionSha { 5 | shouldVoid = false 6 | 7 | constructor(cache, path) { 8 | this.cache = cache 9 | this.path = path 10 | } 11 | 12 | static async load(path) { 13 | return new CacheVersionSha(JSON.parse(await fs.readFile(path, 'utf-8')), path) 14 | } 15 | 16 | get keys() { 17 | return Object.keys(this.cache) 18 | } 19 | 20 | voidOnNewKey(keys) { 21 | if (keys.length !== this.keys.length || !keys.every(key => this.keys.includes(key))) { 22 | this.shouldVoid = true 23 | } 24 | } 25 | 26 | async save() { 27 | const sortedCache = {} 28 | Object.keys(this.cache) 29 | .sort((a, b) => { 30 | const numA = parseInt(a.replace('v', ''), 10) 31 | const numB = parseInt(b.replace('v', ''), 10) 32 | return numA - numB 33 | }) 34 | .forEach(key => { 35 | sortedCache[key] = this.cache[key] 36 | }) 37 | this.cache = sortedCache 38 | await fs.writeFile(this.path, JSON.stringify(this.cache, null, 2)) 39 | return this 40 | } 41 | 42 | set(id, sha) { 43 | this.cache[id] = sha 44 | return this 45 | } 46 | 47 | same(id, value) { 48 | if (this.shouldVoid) return false 49 | return this.cache[id] === value 50 | } 51 | } 52 | 53 | module.exports = { 54 | CacheVersionSha, 55 | } 56 | -------------------------------------------------------------------------------- /cli/lib/log.js: -------------------------------------------------------------------------------- 1 | const {log} = require('proc-log') 2 | const SYMBOL = Symbol('doc-log') 3 | 4 | module.exports = Object.fromEntries(Object.entries(log).map(([k, v]) => [k, (...a) => v(SYMBOL, ...a)])) 5 | 6 | /* istanbul ignore next */ 7 | module.exports.on = loglevel => 8 | process.on('log', (l, s, ...args) => { 9 | // If loglevel is verbose, show everything. Otherwise only show things 10 | // that are not verbose. The script only uses verbose and info, so this 11 | // approach works for now. 12 | if (s === SYMBOL && (loglevel === 'verbose' || l !== 'verbose')) { 13 | console.error(l, ...args) 14 | } 15 | }) 16 | -------------------------------------------------------------------------------- /cli/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "cli", 3 | "private": true, 4 | "repository": { 5 | "url": "git+https://github.com/npm/documentation.git", 6 | "directory": "cli", 7 | "type": "git" 8 | }, 9 | "scripts": { 10 | "build": "node bin/build.js", 11 | "lint": "npm run eslint", 12 | "postlint": "template-oss-check", 13 | "template-oss-apply": "template-oss-apply --force", 14 | "lintfix": "npm run eslint -- --fix", 15 | "snap": "tap", 16 | "test": "tap", 17 | "posttest": "npm run lint", 18 | "eslint": "eslint \"**/*.{js,cjs,ts,mjs,jsx,tsx}\"" 19 | }, 20 | "dependencies": { 21 | "@octokit/rest": "^22.0.0", 22 | "@prettier/sync": "^0.5.0", 23 | "front-matter": "^4.0.2", 24 | "minimatch": "^10.0.1", 25 | "minipass": "^7.0.4", 26 | "pacote": "^21.0.0", 27 | "proc-log": "^5.0.0", 28 | "semver": "^7.5.4", 29 | "tar": "^7.0.1", 30 | "yaml": "^2.3.4" 31 | }, 32 | "devDependencies": { 33 | "@npmcli/eslint-config": "^5.0.0", 34 | "@npmcli/template-oss": "4.24.3", 35 | "tap": "^21.0.0" 36 | }, 37 | "author": "GitHub Inc.", 38 | "engines": { 39 | "node": ">=22.0.0" 40 | }, 41 | "templateOSS": { 42 | "//@npmcli/template-oss": "This file is partially managed by @npmcli/template-oss. Edits may be overwritten.", 43 | "version": "4.24.3", 44 | "content": "./scripts/template-oss" 45 | }, 46 | "files": [ 47 | "bin/", 48 | "lib/" 49 | ], 50 | "tap": { 51 | "allow-incomplete-coverage": true, 52 | "show-full-coverage": true 53 | }, 54 | "nyc": { 55 | "exclude": [] 56 | } 57 | } 58 | -------------------------------------------------------------------------------- /cli/releases.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "id": "v8", 4 | "branch": "release/v8" 5 | }, 6 | { 7 | "id": "v9", 8 | "branch": "release/v9" 9 | }, 10 | { 11 | "id": "v10", 12 | "branch": "release/v10" 13 | }, 14 | { 15 | "id": "v11", 16 | "branch": "latest" 17 | } 18 | ] 19 | -------------------------------------------------------------------------------- /cli/scripts/template-oss/_step-deps-yml.hbs: -------------------------------------------------------------------------------- 1 | - name: Install Dependencies 2 | run: {{ rootNpmPath }} i --no-audit --no-fund {{~#if jobDepFlags}} {{ jobDepFlags }}{{/if}} 3 | -------------------------------------------------------------------------------- /cli/scripts/template-oss/index.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | ...require('../../../scripts/template-oss'), 3 | workspaceRepo: { 4 | add: { 5 | '.github/workflows/update-cli.yml': 'update-cli-yml.hbs', 6 | }, 7 | }, 8 | allowPaths: ['/releases.json'], 9 | } 10 | -------------------------------------------------------------------------------- /cli/scripts/template-oss/update-cli-yml.hbs: -------------------------------------------------------------------------------- 1 | name: Update CLI 2 | 3 | on: 4 | workflow_dispatch: 5 | schedule: 6 | - cron: "14 2 * * *" 7 | 8 | jobs: 9 | update-cli: 10 | outputs: 11 | has_changes: $\{{ steps.status.outputs.has_changes }} 12 | {{> jobYml jobName="Update CLI" }} 13 | - name: Build documentation 14 | run: npm run build -w cli 15 | env: 16 | # token is used to get files from `npm/cli` that 17 | # are not present in the published tarball 18 | GITHUB_TOKEN: $\{{ secrets.GITHUB_TOKEN }} 19 | - name: Check for changes 20 | id: status 21 | run: | 22 | if [ -n "$(git status --porcelain)" ]; then 23 | echo "::set-output name=has_changes::1" 24 | fi 25 | - name: Check in source updates 26 | if: steps.status.outputs.has_changes == '1' 27 | run: | 28 | git add --verbose . 29 | git commit -m 'CLI documentation update from CI' 30 | git push origin main 31 | 32 | publish: 33 | needs: update-cli 34 | if: needs.update-cli.outputs.has_changes == '1' 35 | uses: ./.github/workflows/publish.yml 36 | -------------------------------------------------------------------------------- /content/404.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Page Not Found 3 | edit_on_github: false 4 | --- 5 | 6 | 7 | -------------------------------------------------------------------------------- /content/cli/v10/commands/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: CLI Commands 3 | shortName: Commands 4 | github_repo: npm/cli 5 | github_branch: release/v10 6 | github_path: docs/lib/content/nav.yml 7 | redirect_from: 8 | - /cli-documentation/v10/cli-commands 9 | - /cli-documentation/v10/cli-commands/index 10 | - /cli-documentation/v10/commands 11 | - /cli-documentation/v10/commands/index 12 | - /cli/v10/cli-commands 13 | - /cli/v10/cli-commands/index 14 | - /cli/v10/commands/index 15 | --- 16 | 17 | 18 | -------------------------------------------------------------------------------- /content/cli/v10/commands/npm-help-search.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-help-search 3 | section: 1 4 | description: Search npm help documentation 5 | github_repo: npm/cli 6 | github_branch: release/v10 7 | github_path: docs/lib/content/commands/npm-help-search.md 8 | redirect_from: 9 | - /cli-documentation/v10/cli-commands/help-search 10 | - /cli-documentation/v10/cli-commands/npm-help-search 11 | - /cli-documentation/v10/commands/help-search 12 | - /cli-documentation/v10/commands/npm-help-search 13 | - /cli-documentation/v10/help-search 14 | - /cli-documentation/v10/npm-help-search 15 | - /cli/v10/cli-commands/help-search 16 | - /cli/v10/cli-commands/npm-help-search 17 | - /cli/v10/commands/help-search 18 | - /cli/v10/help-search 19 | - /cli/v10/npm-help-search 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm help-search 26 | ``` 27 | 28 | Note: This command is unaware of workspaces. 29 | 30 | ### Description 31 | 32 | This command will search the npm markdown documentation files for the terms provided, and then list the results, sorted by relevance. 33 | 34 | If only one result is found, then it will show that help topic. 35 | 36 | If the argument to `npm help` is not a known help topic, then it will call `help-search`. It is rarely if ever necessary to call this command directly. 37 | 38 | ### Configuration 39 | 40 | #### `long` 41 | 42 | - Default: false 43 | - Type: Boolean 44 | 45 | Show extended information in `ls`, `search`, and `help-search`. 46 | 47 | ### See Also 48 | 49 | - [npm](/cli/v10/commands/npm) 50 | - [npm help](/cli/v10/commands/npm-help) 51 | -------------------------------------------------------------------------------- /content/cli/v10/commands/npm-ping.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-ping 3 | section: 1 4 | description: Ping npm registry 5 | github_repo: npm/cli 6 | github_branch: release/v10 7 | github_path: docs/lib/content/commands/npm-ping.md 8 | redirect_from: 9 | - /cli-documentation/v10/cli-commands/npm-ping 10 | - /cli-documentation/v10/cli-commands/ping 11 | - /cli-documentation/v10/commands/npm-ping 12 | - /cli-documentation/v10/commands/ping 13 | - /cli-documentation/v10/npm-ping 14 | - /cli-documentation/v10/ping 15 | - /cli/v10/cli-commands/npm-ping 16 | - /cli/v10/cli-commands/ping 17 | - /cli/v10/commands/ping 18 | - /cli/v10/npm-ping 19 | - /cli/v10/ping 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm ping 26 | ``` 27 | 28 | Note: This command is unaware of workspaces. 29 | 30 | ### Description 31 | 32 | Ping the configured or given npm registry and verify authentication. If it works it will output something like: 33 | 34 | ```bash 35 | npm notice PING https://registry.npmjs.org/ 36 | npm notice PONG 255ms 37 | ``` 38 | 39 | otherwise you will get an error: 40 | 41 | ```bash 42 | npm notice PING http://foo.com/ 43 | npm ERR! code E404 44 | npm ERR! 404 Not Found - GET http://www.foo.com/-/ping?write=true 45 | ``` 46 | 47 | ### Configuration 48 | 49 | #### `registry` 50 | 51 | - Default: "https://registry.npmjs.org/" 52 | - Type: URL 53 | 54 | The base URL of the npm registry. 55 | 56 | ### See Also 57 | 58 | - [npm doctor](/cli/v10/commands/npm-doctor) 59 | - [npm config](/cli/v10/commands/npm-config) 60 | - [npmrc](/cli/v10/configuring-npm/npmrc) 61 | -------------------------------------------------------------------------------- /content/cli/v10/commands/npm-stars.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-stars 3 | section: 1 4 | description: View packages marked as favorites 5 | github_repo: npm/cli 6 | github_branch: release/v10 7 | github_path: docs/lib/content/commands/npm-stars.md 8 | redirect_from: 9 | - /cli-documentation/v10/cli-commands/npm-stars 10 | - /cli-documentation/v10/cli-commands/stars 11 | - /cli-documentation/v10/commands/npm-stars 12 | - /cli-documentation/v10/commands/stars 13 | - /cli-documentation/v10/npm-stars 14 | - /cli-documentation/v10/stars 15 | - /cli/v10/cli-commands/npm-stars 16 | - /cli/v10/cli-commands/stars 17 | - /cli/v10/commands/stars 18 | - /cli/v10/npm-stars 19 | - /cli/v10/stars 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm stars [] 26 | ``` 27 | 28 | Note: This command is unaware of workspaces. 29 | 30 | ### Description 31 | 32 | If you have starred a lot of neat things and want to find them again quickly this command lets you do just that. 33 | 34 | You may also want to see your friend's favorite packages, in this case you will most certainly enjoy this command. 35 | 36 | ### Configuration 37 | 38 | #### `registry` 39 | 40 | - Default: "https://registry.npmjs.org/" 41 | - Type: URL 42 | 43 | The base URL of the npm registry. 44 | 45 | ### See Also 46 | 47 | - [npm star](/cli/v10/commands/npm-star) 48 | - [npm unstar](/cli/v10/commands/npm-unstar) 49 | - [npm view](/cli/v10/commands/npm-view) 50 | - [npm whoami](/cli/v10/commands/npm-whoami) 51 | - [npm adduser](/cli/v10/commands/npm-adduser) 52 | -------------------------------------------------------------------------------- /content/cli/v10/commands/npm-whoami.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-whoami 3 | section: 1 4 | description: Display npm username 5 | github_repo: npm/cli 6 | github_branch: release/v10 7 | github_path: docs/lib/content/commands/npm-whoami.md 8 | redirect_from: 9 | - /cli-documentation/v10/cli-commands/npm-whoami 10 | - /cli-documentation/v10/cli-commands/whoami 11 | - /cli-documentation/v10/commands/npm-whoami 12 | - /cli-documentation/v10/commands/whoami 13 | - /cli-documentation/v10/npm-whoami 14 | - /cli-documentation/v10/whoami 15 | - /cli/v10/cli-commands/npm-whoami 16 | - /cli/v10/cli-commands/whoami 17 | - /cli/v10/commands/whoami 18 | - /cli/v10/npm-whoami 19 | - /cli/v10/whoami 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm whoami 26 | ``` 27 | 28 | Note: This command is unaware of workspaces. 29 | 30 | ### Description 31 | 32 | Display the npm username of the currently logged-in user. 33 | 34 | If logged into a registry that provides token-based authentication, then connect to the `/-/whoami` registry endpoint to find the username associated with the token, and print to standard output. 35 | 36 | If logged into a registry that uses Basic Auth, then simply print the `username` portion of the authentication string. 37 | 38 | ### Configuration 39 | 40 | #### `registry` 41 | 42 | - Default: "https://registry.npmjs.org/" 43 | - Type: URL 44 | 45 | The base URL of the npm registry. 46 | 47 | ### See Also 48 | 49 | - [npm config](/cli/v10/commands/npm-config) 50 | - [npmrc](/cli/v10/configuring-npm/npmrc) 51 | - [npm adduser](/cli/v10/commands/npm-adduser) 52 | -------------------------------------------------------------------------------- /content/cli/v10/configuring-npm/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Configuring npm 3 | shortName: Configuring 4 | github_repo: npm/cli 5 | github_branch: release/v10 6 | github_path: docs/lib/content/nav.yml 7 | redirect_from: 8 | - /cli-documentation/v10/configuring-npm 9 | - /cli-documentation/v10/configuring-npm/index 10 | - /cli-documentation/v10/files 11 | - /cli-documentation/v10/files/index 12 | - /cli/v10/configuring-npm/index 13 | - /cli/v10/files 14 | - /cli/v10/files/index 15 | --- 16 | 17 | 18 | -------------------------------------------------------------------------------- /content/cli/v10/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm CLI 3 | shortName: CLI 4 | github_repo: npm/cli 5 | github_branch: release/v10 6 | github_path: docs/lib/content/nav.yml 7 | redirect_from: 8 | - /cli-documentation/v10 9 | - /cli-documentation/v10/index 10 | - /cli/v10/index 11 | --- 12 | 13 | 14 | -------------------------------------------------------------------------------- /content/cli/v10/using-npm/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Using npm 3 | shortName: Using 4 | github_repo: npm/cli 5 | github_branch: release/v10 6 | github_path: docs/lib/content/nav.yml 7 | redirect_from: 8 | - /cli-documentation/v10/misc 9 | - /cli-documentation/v10/misc/index 10 | - /cli-documentation/v10/using-npm 11 | - /cli-documentation/v10/using-npm/index 12 | - /cli/v10/misc 13 | - /cli/v10/misc/index 14 | - /cli/v10/using-npm/index 15 | --- 16 | 17 | 18 | -------------------------------------------------------------------------------- /content/cli/v11/commands/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: CLI Commands 3 | shortName: Commands 4 | github_repo: npm/cli 5 | github_branch: latest 6 | github_path: docs/lib/content/nav.yml 7 | redirect_from: 8 | - /cli-commands 9 | - /cli-commands/index 10 | - /cli-documentation/cli 11 | - /cli-documentation/cli-commands 12 | - /cli-documentation/cli-commands/index 13 | - /cli-documentation/commands 14 | - /cli-documentation/commands/index 15 | - /cli-documentation/v11/cli-commands 16 | - /cli-documentation/v11/cli-commands/index 17 | - /cli-documentation/v11/commands 18 | - /cli-documentation/v11/commands/index 19 | - /cli/cli-commands 20 | - /cli/cli-commands/index 21 | - /cli/commands 22 | - /cli/commands/index 23 | - /cli/v11/cli-commands 24 | - /cli/v11/cli-commands/index 25 | - /cli/v11/commands/index 26 | - /commands 27 | - /commands/index 28 | --- 29 | 30 | 31 | -------------------------------------------------------------------------------- /content/cli/v11/configuring-npm/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Configuring npm 3 | shortName: Configuring 4 | github_repo: npm/cli 5 | github_branch: latest 6 | github_path: docs/lib/content/nav.yml 7 | redirect_from: 8 | - /cli-documentation/configuring-npm 9 | - /cli-documentation/configuring-npm/index 10 | - /cli-documentation/files 11 | - /cli-documentation/files/index 12 | - /cli-documentation/v11/configuring-npm 13 | - /cli-documentation/v11/configuring-npm/index 14 | - /cli-documentation/v11/files 15 | - /cli-documentation/v11/files/index 16 | - /cli/configuring-npm 17 | - /cli/configuring-npm/index 18 | - /cli/files 19 | - /cli/files/index 20 | - /cli/v11/configuring-npm/index 21 | - /cli/v11/files 22 | - /cli/v11/files/index 23 | - /configuring-npm 24 | - /configuring-npm/index 25 | - /files 26 | - /files/index 27 | --- 28 | 29 | 30 | -------------------------------------------------------------------------------- /content/cli/v11/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm CLI 3 | shortName: CLI 4 | github_repo: npm/cli 5 | github_branch: latest 6 | github_path: docs/lib/content/nav.yml 7 | redirect_from: 8 | - /cli 9 | - /cli-documentation 10 | - /cli-documentation/index 11 | - /cli-documentation/v11 12 | - /cli-documentation/v11/index 13 | - /cli/index 14 | - /cli/v11/index 15 | --- 16 | 17 | 18 | -------------------------------------------------------------------------------- /content/cli/v11/using-npm/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Using npm 3 | shortName: Using 4 | github_repo: npm/cli 5 | github_branch: latest 6 | github_path: docs/lib/content/nav.yml 7 | redirect_from: 8 | - /cli-documentation/misc 9 | - /cli-documentation/misc/index 10 | - /cli-documentation/using-npm 11 | - /cli-documentation/using-npm/index 12 | - /cli-documentation/v11/misc 13 | - /cli-documentation/v11/misc/index 14 | - /cli-documentation/v11/using-npm 15 | - /cli-documentation/v11/using-npm/index 16 | - /cli/misc 17 | - /cli/misc/index 18 | - /cli/using-npm 19 | - /cli/using-npm/index 20 | - /cli/v11/misc 21 | - /cli/v11/misc/index 22 | - /cli/v11/using-npm/index 23 | - /misc 24 | - /misc/index 25 | - /using-npm 26 | - /using-npm/index 27 | --- 28 | 29 | 30 | -------------------------------------------------------------------------------- /content/cli/v6/commands/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: CLI Commands 3 | shortName: Commands 4 | github_repo: npm/cli 5 | github_branch: release/v6 6 | github_path: docs/nav.yml 7 | redirect_from: 8 | - /cli-documentation/v6/cli-commands 9 | - /cli-documentation/v6/cli-commands/index 10 | - /cli-documentation/v6/commands 11 | - /cli-documentation/v6/commands/index 12 | - /cli/v6/cli-commands 13 | - /cli/v6/cli-commands/index 14 | - /cli/v6/commands/index 15 | --- 16 | 17 | 18 | -------------------------------------------------------------------------------- /content/cli/v6/commands/npm-bin.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-bin 3 | section: 1 4 | description: Display npm bin folder 5 | github_repo: npm/cli 6 | github_branch: release/v6 7 | github_path: docs/content/commands/npm-bin.md 8 | redirect_from: 9 | - /cli-documentation/v6/bin 10 | - /cli-documentation/v6/cli-commands/bin 11 | - /cli-documentation/v6/cli-commands/npm-bin 12 | - /cli-documentation/v6/commands/bin 13 | - /cli-documentation/v6/commands/npm-bin 14 | - /cli-documentation/v6/npm-bin 15 | - /cli/v6/bin 16 | - /cli/v6/cli-commands/bin 17 | - /cli/v6/cli-commands/npm-bin 18 | - /cli/v6/commands/bin 19 | - /cli/v6/npm-bin 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm bin [-g|--global] 26 | ``` 27 | 28 | ### Description 29 | 30 | Print the folder where npm will install executables. 31 | 32 | ### See Also 33 | 34 | - [npm prefix](/cli/v6/commands/npm-prefix) 35 | - [npm root](/cli/v6/commands/npm-root) 36 | - [npm folders](/cli/v6/configuring-npm/folders) 37 | - [npm config](/cli/v6/commands/npm-config) 38 | - [npmrc](/cli/v6/configuring-npm/npmrc) 39 | -------------------------------------------------------------------------------- /content/cli/v6/commands/npm-build.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-build 3 | section: 1 4 | description: Build a package 5 | github_repo: npm/cli 6 | github_branch: release/v6 7 | github_path: docs/content/commands/npm-build.md 8 | redirect_from: 9 | - /cli-documentation/v6/build 10 | - /cli-documentation/v6/cli-commands/build 11 | - /cli-documentation/v6/cli-commands/npm-build 12 | - /cli-documentation/v6/commands/build 13 | - /cli-documentation/v6/commands/npm-build 14 | - /cli-documentation/v6/npm-build 15 | - /cli/v6/build 16 | - /cli/v6/cli-commands/build 17 | - /cli/v6/cli-commands/npm-build 18 | - /cli/v6/commands/build 19 | - /cli/v6/npm-build 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```shell 25 | npm build [] 26 | ``` 27 | 28 | - ``: A folder containing a `package.json` file in its root. 29 | 30 | ### Description 31 | 32 | This is the plumbing command called by `npm link` and `npm install`. 33 | 34 | It should generally be called during installation, but if you need to run it directly, run: 35 | 36 | ```bash 37 | npm build 38 | ``` 39 | 40 | ### See Also 41 | 42 | - [npm install](/cli/v6/commands/npm-install) 43 | - [npm link](/cli/v6/commands/npm-link) 44 | - [npm scripts](/cli/v6/using-npm/scripts) 45 | - [package.json](/cli/v6/configuring-npm/package-json) 46 | -------------------------------------------------------------------------------- /content/cli/v6/commands/npm-bundle.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-bundle 3 | section: 1 4 | description: REMOVED 5 | github_repo: npm/cli 6 | github_branch: release/v6 7 | github_path: docs/content/commands/npm-bundle.md 8 | redirect_from: 9 | - /cli-documentation/v6/bundle 10 | - /cli-documentation/v6/cli-commands/bundle 11 | - /cli-documentation/v6/cli-commands/npm-bundle 12 | - /cli-documentation/v6/commands/bundle 13 | - /cli-documentation/v6/commands/npm-bundle 14 | - /cli-documentation/v6/npm-bundle 15 | - /cli/v6/bundle 16 | - /cli/v6/cli-commands/bundle 17 | - /cli/v6/cli-commands/npm-bundle 18 | - /cli/v6/commands/bundle 19 | - /cli/v6/npm-bundle 20 | --- 21 | 22 | ### Description 23 | 24 | The `npm bundle` command has been removed in 1.0, for the simple reason that it is no longer necessary, as the default behavior is now to install packages into the local space. 25 | 26 | Just use `npm install` now to do what `npm bundle` used to do. 27 | 28 | ### See Also 29 | 30 | - [npm install](/cli/v6/commands/npm-install) 31 | -------------------------------------------------------------------------------- /content/cli/v6/commands/npm-completion.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-completion 3 | section: 1 4 | description: Tab Completion for npm 5 | github_repo: npm/cli 6 | github_branch: release/v6 7 | github_path: docs/content/commands/npm-completion.md 8 | redirect_from: 9 | - /cli-documentation/v6/cli-commands/completion 10 | - /cli-documentation/v6/cli-commands/npm-completion 11 | - /cli-documentation/v6/commands/completion 12 | - /cli-documentation/v6/commands/npm-completion 13 | - /cli-documentation/v6/completion 14 | - /cli-documentation/v6/npm-completion 15 | - /cli/v6/cli-commands/completion 16 | - /cli/v6/cli-commands/npm-completion 17 | - /cli/v6/commands/completion 18 | - /cli/v6/completion 19 | - /cli/v6/npm-completion 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | source <(npm completion) 26 | ``` 27 | 28 | ### Description 29 | 30 | Enables tab-completion in all npm commands. 31 | 32 | The synopsis above loads the completions into your current shell. Adding it to your ~/.bashrc or ~/.zshrc will make the completions available everywhere: 33 | 34 | ```bash 35 | npm completion >> ~/.bashrc 36 | npm completion >> ~/.zshrc 37 | ``` 38 | 39 | You may of course also pipe the output of `npm completion` to a file such as `/usr/local/etc/bash_completion.d/npm` or `/etc/bash_completion.d/npm` if you have a system that will read that file for you. 40 | 41 | When `COMP_CWORD`, `COMP_LINE`, and `COMP_POINT` are defined in the environment, `npm completion` acts in "plumbing mode", and outputs completions based on the arguments. 42 | 43 | ### See Also 44 | 45 | - [npm developers](/cli/v6/using-npm/developers) 46 | - [npm](/cli/v6/commands/npm) 47 | -------------------------------------------------------------------------------- /content/cli/v6/commands/npm-deprecate.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-deprecate 3 | section: 1 4 | description: Deprecate a version of a package 5 | github_repo: npm/cli 6 | github_branch: release/v6 7 | github_path: docs/content/commands/npm-deprecate.md 8 | redirect_from: 9 | - /cli-documentation/v6/cli-commands/deprecate 10 | - /cli-documentation/v6/cli-commands/npm-deprecate 11 | - /cli-documentation/v6/commands/deprecate 12 | - /cli-documentation/v6/commands/npm-deprecate 13 | - /cli-documentation/v6/deprecate 14 | - /cli-documentation/v6/npm-deprecate 15 | - /cli/v6/cli-commands/deprecate 16 | - /cli/v6/cli-commands/npm-deprecate 17 | - /cli/v6/commands/deprecate 18 | - /cli/v6/deprecate 19 | - /cli/v6/npm-deprecate 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm deprecate [@] 26 | ``` 27 | 28 | ### Description 29 | 30 | This command will update the npm registry entry for a package, providing a deprecation warning to all who attempt to install it. 31 | 32 | It works on [version ranges](https://semver.npmjs.com/) as well as specific versions, so you can do something like this: 33 | 34 | ```bash 35 | npm deprecate my-thing@"< 0.2.3" "critical bug fixed in v0.2.3" 36 | ``` 37 | 38 | Note that you must be the package owner to deprecate something. See the `owner` and `adduser` help topics. 39 | 40 | To un-deprecate a package, specify an empty string (`""`) for the `message` argument. Note that you must use double quotes with no space between them to format an empty string. 41 | 42 | ### See Also 43 | 44 | - [npm publish](/cli/v6/commands/npm-publish) 45 | - [npm registry](/cli/v6/using-npm/registry) 46 | -------------------------------------------------------------------------------- /content/cli/v6/commands/npm-help-search.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-help-search 3 | section: 1 4 | description: Search npm help documentation 5 | github_repo: npm/cli 6 | github_branch: release/v6 7 | github_path: docs/content/commands/npm-help-search.md 8 | redirect_from: 9 | - /cli-documentation/v6/cli-commands/help-search 10 | - /cli-documentation/v6/cli-commands/npm-help-search 11 | - /cli-documentation/v6/commands/help-search 12 | - /cli-documentation/v6/commands/npm-help-search 13 | - /cli-documentation/v6/help-search 14 | - /cli-documentation/v6/npm-help-search 15 | - /cli/v6/cli-commands/help-search 16 | - /cli/v6/cli-commands/npm-help-search 17 | - /cli/v6/commands/help-search 18 | - /cli/v6/help-search 19 | - /cli/v6/npm-help-search 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm help-search 26 | ``` 27 | 28 | ### Description 29 | 30 | This command will search the npm markdown documentation files for the terms provided, and then list the results, sorted by relevance. 31 | 32 | If only one result is found, then it will show that help topic. 33 | 34 | If the argument to `npm help` is not a known help topic, then it will call `help-search`. It is rarely if ever necessary to call this command directly. 35 | 36 | ### Configuration 37 | 38 | #### long 39 | 40 | - Type: Boolean 41 | - Default: false 42 | 43 | If true, the "long" flag will cause help-search to output context around where the terms were found in the documentation. 44 | 45 | If false, then help-search will just list out the help topics found. 46 | 47 | ### See Also 48 | 49 | - [npm](/cli/v6/commands/npm) 50 | - [npm help](/cli/v6/commands/npm-help) 51 | -------------------------------------------------------------------------------- /content/cli/v6/commands/npm-help.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-help 3 | section: 1 4 | description: Get help on npm 5 | github_repo: npm/cli 6 | github_branch: release/v6 7 | github_path: docs/content/commands/npm-help.md 8 | redirect_from: 9 | - /cli-documentation/v6/cli-commands/help 10 | - /cli-documentation/v6/cli-commands/npm-help 11 | - /cli-documentation/v6/commands/help 12 | - /cli-documentation/v6/commands/npm-help 13 | - /cli-documentation/v6/help 14 | - /cli-documentation/v6/npm-help 15 | - /cli/v6/cli-commands/help 16 | - /cli/v6/cli-commands/npm-help 17 | - /cli/v6/commands/help 18 | - /cli/v6/help 19 | - /cli/v6/npm-help 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm help [] 26 | ``` 27 | 28 | ### Description 29 | 30 | If supplied a topic, then show the appropriate documentation page. 31 | 32 | 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 topic, so unique matches are equivalent to specifying a topic name. 33 | 34 | ### Configuration 35 | 36 | #### viewer 37 | 38 | - Default: "man" on Posix, "browser" on Windows 39 | - Type: path 40 | 41 | The program to use to view help content. 42 | 43 | Set to `"browser"` to view html help content in the default web browser. 44 | 45 | ### See Also 46 | 47 | - [npm](/cli/v6/commands/npm) 48 | - [npm folders](/cli/v6/configuring-npm/folders) 49 | - [npm config](/cli/v6/commands/npm-config) 50 | - [npmrc](/cli/v6/configuring-npm/npmrc) 51 | - [package.json](/cli/v6/configuring-npm/package-json) 52 | - [npm help-search](/cli/v6/commands/npm-help-search) 53 | -------------------------------------------------------------------------------- /content/cli/v6/commands/npm-install-ci-test.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-install-ci-test 3 | section: 1 4 | description: Install a project with a clean slate and run tests 5 | github_repo: npm/cli 6 | github_branch: release/v6 7 | github_path: docs/content/commands/npm-install-ci-test.md 8 | redirect_from: 9 | - /cli-documentation/v6/cli-commands/install-ci-test 10 | - /cli-documentation/v6/cli-commands/npm-install-ci-test 11 | - /cli-documentation/v6/commands/install-ci-test 12 | - /cli-documentation/v6/commands/npm-install-ci-test 13 | - /cli-documentation/v6/install-ci-test 14 | - /cli-documentation/v6/npm-install-ci-test 15 | - /cli/v6/cli-commands/install-ci-test 16 | - /cli/v6/cli-commands/npm-install-ci-test 17 | - /cli/v6/commands/install-ci-test 18 | - /cli/v6/install-ci-test 19 | - /cli/v6/npm-install-ci-test 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm install-ci-test 26 | 27 | alias: npm cit 28 | ``` 29 | 30 | ### Description 31 | 32 | This command runs an `npm ci` followed immediately by an `npm test`. 33 | 34 | ### See Also 35 | 36 | - [npm ci](/cli/v6/commands/npm-ci) 37 | - [npm test](/cli/v6/commands/npm-test) 38 | -------------------------------------------------------------------------------- /content/cli/v6/commands/npm-install-test.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-install-test 3 | section: 1 4 | description: Install package(s) and run tests 5 | github_repo: npm/cli 6 | github_branch: release/v6 7 | github_path: docs/content/commands/npm-install-test.md 8 | redirect_from: 9 | - /cli-documentation/v6/cli-commands/install-test 10 | - /cli-documentation/v6/cli-commands/npm-install-test 11 | - /cli-documentation/v6/commands/install-test 12 | - /cli-documentation/v6/commands/npm-install-test 13 | - /cli-documentation/v6/install-test 14 | - /cli-documentation/v6/npm-install-test 15 | - /cli/v6/cli-commands/install-test 16 | - /cli/v6/cli-commands/npm-install-test 17 | - /cli/v6/commands/install-test 18 | - /cli/v6/install-test 19 | - /cli/v6/npm-install-test 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm install-test (with no args, in package dir) 26 | npm install-test [<@scope>/] 27 | npm install-test [<@scope>/]@ 28 | npm install-test [<@scope>/]@ 29 | npm install-test [<@scope>/]@ 30 | npm install-test 31 | npm install-test 32 | npm install-test 33 | 34 | alias: npm it 35 | common options: [--save|--save-dev|--save-optional] [--save-exact] [--dry-run] 36 | ``` 37 | 38 | ### Description 39 | 40 | This command runs an `npm install` followed immediately by an `npm test`. It takes exactly the same arguments as `npm install`. 41 | 42 | ### See Also 43 | 44 | - [npm install](/cli/v6/commands/npm-install) 45 | - [npm test](/cli/v6/commands/npm-test) 46 | -------------------------------------------------------------------------------- /content/cli/v6/commands/npm-pack.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-pack 3 | section: 1 4 | description: Create a tarball from a package 5 | github_repo: npm/cli 6 | github_branch: release/v6 7 | github_path: docs/content/commands/npm-pack.md 8 | redirect_from: 9 | - /cli-documentation/v6/cli-commands/npm-pack 10 | - /cli-documentation/v6/cli-commands/pack 11 | - /cli-documentation/v6/commands/npm-pack 12 | - /cli-documentation/v6/commands/pack 13 | - /cli-documentation/v6/npm-pack 14 | - /cli-documentation/v6/pack 15 | - /cli/v6/cli-commands/npm-pack 16 | - /cli/v6/cli-commands/pack 17 | - /cli/v6/commands/pack 18 | - /cli/v6/npm-pack 19 | - /cli/v6/pack 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm pack [[<@scope>/]...] [--dry-run] 26 | ``` 27 | 28 | ### Description 29 | 30 | For anything that's installable (that is, a package folder, tarball, tarball url, name@tag, name@version, name, or scoped name), this command will fetch it to the cache, and then copy the tarball to the current working directory as `-.tgz`, and then write the filenames out to stdout. 31 | 32 | If the same package is specified multiple times, then the file will be overwritten the second time. 33 | 34 | If no arguments are supplied, then npm packs the current package folder. 35 | 36 | The `--dry-run` argument will do everything that pack usually does without actually packing anything. Reports on what would have gone into the tarball. 37 | 38 | ### See Also 39 | 40 | - [npm cache](/cli/v6/commands/npm-cache) 41 | - [npm publish](/cli/v6/commands/npm-publish) 42 | - [npm config](/cli/v6/commands/npm-config) 43 | - [npmrc](/cli/v6/configuring-npm/npmrc) 44 | -------------------------------------------------------------------------------- /content/cli/v6/commands/npm-ping.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-ping 3 | section: 1 4 | description: Ping npm registry 5 | github_repo: npm/cli 6 | github_branch: release/v6 7 | github_path: docs/content/commands/npm-ping.md 8 | redirect_from: 9 | - /cli-documentation/v6/cli-commands/npm-ping 10 | - /cli-documentation/v6/cli-commands/ping 11 | - /cli-documentation/v6/commands/npm-ping 12 | - /cli-documentation/v6/commands/ping 13 | - /cli-documentation/v6/npm-ping 14 | - /cli-documentation/v6/ping 15 | - /cli/v6/cli-commands/npm-ping 16 | - /cli/v6/cli-commands/ping 17 | - /cli/v6/commands/ping 18 | - /cli/v6/npm-ping 19 | - /cli/v6/ping 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm ping [--registry ] 26 | ``` 27 | 28 | ### Description 29 | 30 | Ping the configured or given npm registry and verify authentication. If it works it will output something like: 31 | 32 | ```bash 33 | Ping success: {*Details about registry*} 34 | ``` 35 | 36 | otherwise you will get: 37 | 38 | ```bash 39 | Ping error: {*Detail about error} 40 | ``` 41 | 42 | ### See Also 43 | 44 | - [npm config](/cli/v6/commands/npm-config) 45 | - [npmrc](/cli/v6/configuring-npm/npmrc) 46 | -------------------------------------------------------------------------------- /content/cli/v6/commands/npm-prefix.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-prefix 3 | section: 1 4 | description: Display prefix 5 | github_repo: npm/cli 6 | github_branch: release/v6 7 | github_path: docs/content/commands/npm-prefix.md 8 | redirect_from: 9 | - /cli-documentation/v6/cli-commands/npm-prefix 10 | - /cli-documentation/v6/cli-commands/prefix 11 | - /cli-documentation/v6/commands/npm-prefix 12 | - /cli-documentation/v6/commands/prefix 13 | - /cli-documentation/v6/npm-prefix 14 | - /cli-documentation/v6/prefix 15 | - /cli/v6/cli-commands/npm-prefix 16 | - /cli/v6/cli-commands/prefix 17 | - /cli/v6/commands/prefix 18 | - /cli/v6/npm-prefix 19 | - /cli/v6/prefix 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm prefix [-g] 26 | ``` 27 | 28 | ### Description 29 | 30 | Print 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. 31 | 32 | If `-g` is specified, this will be the value of the global prefix. See [`npm config`](/cli/v6/commands/npm-config) for more detail. 33 | 34 | ### See Also 35 | 36 | - [npm root](/cli/v6/commands/npm-root) 37 | - [npm bin](/cli/v6/commands/npm-bin) 38 | - [npm folders](/cli/v6/configuring-npm/folders) 39 | - [npm config](/cli/v6/commands/npm-config) 40 | - [npmrc](/cli/v6/configuring-npm/npmrc) 41 | -------------------------------------------------------------------------------- /content/cli/v6/commands/npm-rebuild.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-rebuild 3 | section: 1 4 | description: Rebuild a package 5 | github_repo: npm/cli 6 | github_branch: release/v6 7 | github_path: docs/content/commands/npm-rebuild.md 8 | redirect_from: 9 | - /cli-documentation/v6/cli-commands/npm-rebuild 10 | - /cli-documentation/v6/cli-commands/rebuild 11 | - /cli-documentation/v6/commands/npm-rebuild 12 | - /cli-documentation/v6/commands/rebuild 13 | - /cli-documentation/v6/npm-rebuild 14 | - /cli-documentation/v6/rebuild 15 | - /cli/v6/cli-commands/npm-rebuild 16 | - /cli/v6/cli-commands/rebuild 17 | - /cli/v6/commands/rebuild 18 | - /cli/v6/npm-rebuild 19 | - /cli/v6/rebuild 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm rebuild [[<@scope>/]...] 26 | 27 | alias: npm rb 28 | ``` 29 | 30 | ### Description 31 | 32 | This command runs the `npm build` command on the matched folders. This is useful when you install a new version of node, and must recompile all your C++ addons with the new binary. 33 | 34 | ### See Also 35 | 36 | - [npm build](/cli/v6/commands/npm-build) 37 | - [npm install](/cli/v6/commands/npm-install) 38 | -------------------------------------------------------------------------------- /content/cli/v6/commands/npm-repo.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-repo 3 | section: 1 4 | description: Open package repository page in the browser 5 | github_repo: npm/cli 6 | github_branch: release/v6 7 | github_path: docs/content/commands/npm-repo.md 8 | redirect_from: 9 | - /cli-documentation/v6/cli-commands/npm-repo 10 | - /cli-documentation/v6/cli-commands/repo 11 | - /cli-documentation/v6/commands/npm-repo 12 | - /cli-documentation/v6/commands/repo 13 | - /cli-documentation/v6/npm-repo 14 | - /cli-documentation/v6/repo 15 | - /cli/v6/cli-commands/npm-repo 16 | - /cli/v6/cli-commands/repo 17 | - /cli/v6/commands/repo 18 | - /cli/v6/npm-repo 19 | - /cli/v6/repo 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm repo [] 26 | ``` 27 | 28 | ### Description 29 | 30 | This command tries to guess at the likely location of a package's repository URL, and then tries to open it using the `--browser` config param. If no package name is provided, it will search for a `package.json` in the current folder and use the `name` property. 31 | 32 | ### Configuration 33 | 34 | #### browser 35 | 36 | - Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"` 37 | - Type: String 38 | 39 | The browser that is called by the `npm repo` command to open websites. 40 | 41 | ### See Also 42 | 43 | - [npm docs](/cli/v6/commands/npm-docs) 44 | - [npm config](/cli/v6/commands/npm-config) 45 | -------------------------------------------------------------------------------- /content/cli/v6/commands/npm-root.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-root 3 | section: 1 4 | description: Display npm root 5 | github_repo: npm/cli 6 | github_branch: release/v6 7 | github_path: docs/content/commands/npm-root.md 8 | redirect_from: 9 | - /cli-documentation/v6/cli-commands/npm-root 10 | - /cli-documentation/v6/cli-commands/root 11 | - /cli-documentation/v6/commands/npm-root 12 | - /cli-documentation/v6/commands/root 13 | - /cli-documentation/v6/npm-root 14 | - /cli-documentation/v6/root 15 | - /cli/v6/cli-commands/npm-root 16 | - /cli/v6/cli-commands/root 17 | - /cli/v6/commands/root 18 | - /cli/v6/npm-root 19 | - /cli/v6/root 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm root [-g] 26 | ``` 27 | 28 | ### Description 29 | 30 | Print the effective `node_modules` folder to standard out. 31 | 32 | ### See Also 33 | 34 | - [npm prefix](/cli/v6/commands/npm-prefix) 35 | - [npm bin](/cli/v6/commands/npm-bin) 36 | - [npm folders](/cli/v6/configuring-npm/folders) 37 | - [npm config](/cli/v6/commands/npm-config) 38 | - [npmrc](/cli/v6/configuring-npm/npmrc) 39 | -------------------------------------------------------------------------------- /content/cli/v6/commands/npm-star.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-star 3 | section: 1 4 | description: Mark your favorite packages 5 | github_repo: npm/cli 6 | github_branch: release/v6 7 | github_path: docs/content/commands/npm-star.md 8 | redirect_from: 9 | - /cli-documentation/v6/cli-commands/npm-star 10 | - /cli-documentation/v6/cli-commands/star 11 | - /cli-documentation/v6/commands/npm-star 12 | - /cli-documentation/v6/commands/star 13 | - /cli-documentation/v6/npm-star 14 | - /cli-documentation/v6/star 15 | - /cli/v6/cli-commands/npm-star 16 | - /cli/v6/cli-commands/star 17 | - /cli/v6/commands/star 18 | - /cli/v6/npm-star 19 | - /cli/v6/star 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm star [...] 26 | npm unstar [...] 27 | ``` 28 | 29 | ### Description 30 | 31 | "Starring" a package means that you have some interest in it. It's a vaguely positive way to show that you care. 32 | 33 | "Unstarring" is the same thing, but in reverse. 34 | 35 | It's a boolean thing. Starring repeatedly has no additional effect. 36 | 37 | ### See Also 38 | 39 | - [npm view](/cli/v6/commands/npm-view) 40 | - [npm whoami](/cli/v6/commands/npm-whoami) 41 | - [npm adduser](/cli/v6/commands/npm-adduser) 42 | -------------------------------------------------------------------------------- /content/cli/v6/commands/npm-stars.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-stars 3 | section: 1 4 | description: View packages marked as favorites 5 | github_repo: npm/cli 6 | github_branch: release/v6 7 | github_path: docs/content/commands/npm-stars.md 8 | redirect_from: 9 | - /cli-documentation/v6/cli-commands/npm-stars 10 | - /cli-documentation/v6/cli-commands/stars 11 | - /cli-documentation/v6/commands/npm-stars 12 | - /cli-documentation/v6/commands/stars 13 | - /cli-documentation/v6/npm-stars 14 | - /cli-documentation/v6/stars 15 | - /cli/v6/cli-commands/npm-stars 16 | - /cli/v6/cli-commands/stars 17 | - /cli/v6/commands/stars 18 | - /cli/v6/npm-stars 19 | - /cli/v6/stars 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm stars [] 26 | ``` 27 | 28 | ### Description 29 | 30 | If you have starred a lot of neat things and want to find them again quickly this command lets you do just that. 31 | 32 | You may also want to see your friend's favorite packages, in this case you will most certainly enjoy this command. 33 | 34 | ### See Also 35 | 36 | - [npm star](/cli/v6/commands/npm-star) 37 | - [npm view](/cli/v6/commands/npm-view) 38 | - [npm whoami](/cli/v6/commands/npm-whoami) 39 | - [npm adduser](/cli/v6/commands/npm-adduser) 40 | -------------------------------------------------------------------------------- /content/cli/v6/commands/npm-start.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-start 3 | section: 1 4 | description: Start a package 5 | github_repo: npm/cli 6 | github_branch: release/v6 7 | github_path: docs/content/commands/npm-start.md 8 | redirect_from: 9 | - /cli-documentation/v6/cli-commands/npm-start 10 | - /cli-documentation/v6/cli-commands/start 11 | - /cli-documentation/v6/commands/npm-start 12 | - /cli-documentation/v6/commands/start 13 | - /cli-documentation/v6/npm-start 14 | - /cli-documentation/v6/start 15 | - /cli/v6/cli-commands/npm-start 16 | - /cli/v6/cli-commands/start 17 | - /cli/v6/commands/start 18 | - /cli/v6/npm-start 19 | - /cli/v6/start 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm start [-- ] 26 | ``` 27 | 28 | ### Description 29 | 30 | This runs an arbitrary command specified in the package's `"start"` property of its `"scripts"` object. If no `"start"` property is specified on the `"scripts"` object, it will run `node server.js`. 31 | 32 | As of [`npm@2.0.0`](https://blog.npmjs.org/post/98131109725/npm-2-0-0), you can use custom arguments when executing scripts. Refer to [`npm run-script`](/cli/v6/commands/npm-run-script) for more details. 33 | 34 | ### See Also 35 | 36 | - [npm run-script](/cli/v6/commands/npm-run-script) 37 | - [npm scripts](/cli/v6/using-npm/scripts) 38 | - [npm test](/cli/v6/commands/npm-test) 39 | - [npm restart](/cli/v6/commands/npm-restart) 40 | - [npm stop](/cli/v6/commands/npm-stop) 41 | -------------------------------------------------------------------------------- /content/cli/v6/commands/npm-stop.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-stop 3 | section: 1 4 | description: Stop a package 5 | github_repo: npm/cli 6 | github_branch: release/v6 7 | github_path: docs/content/commands/npm-stop.md 8 | redirect_from: 9 | - /cli-documentation/v6/cli-commands/npm-stop 10 | - /cli-documentation/v6/cli-commands/stop 11 | - /cli-documentation/v6/commands/npm-stop 12 | - /cli-documentation/v6/commands/stop 13 | - /cli-documentation/v6/npm-stop 14 | - /cli-documentation/v6/stop 15 | - /cli/v6/cli-commands/npm-stop 16 | - /cli/v6/cli-commands/stop 17 | - /cli/v6/commands/stop 18 | - /cli/v6/npm-stop 19 | - /cli/v6/stop 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm stop [-- ] 26 | ``` 27 | 28 | ### Description 29 | 30 | This runs a package's "stop" script, if one was provided. 31 | 32 | ### See Also 33 | 34 | - [npm run-script](/cli/v6/commands/npm-run-script) 35 | - [npm scripts](/cli/v6/using-npm/scripts) 36 | - [npm test](/cli/v6/commands/npm-test) 37 | - [npm start](/cli/v6/commands/npm-start) 38 | - [npm restart](/cli/v6/commands/npm-restart) 39 | -------------------------------------------------------------------------------- /content/cli/v6/commands/npm-test.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-test 3 | section: 1 4 | description: Test a package 5 | github_repo: npm/cli 6 | github_branch: release/v6 7 | github_path: docs/content/commands/npm-test.md 8 | redirect_from: 9 | - /cli-documentation/v6/cli-commands/npm-test 10 | - /cli-documentation/v6/cli-commands/test 11 | - /cli-documentation/v6/commands/npm-test 12 | - /cli-documentation/v6/commands/test 13 | - /cli-documentation/v6/npm-test 14 | - /cli-documentation/v6/test 15 | - /cli/v6/cli-commands/npm-test 16 | - /cli/v6/cli-commands/test 17 | - /cli/v6/commands/test 18 | - /cli/v6/npm-test 19 | - /cli/v6/test 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm test [-- ] 26 | 27 | aliases: t, tst 28 | ``` 29 | 30 | ### Description 31 | 32 | This runs a package's "test" script, if one was provided. 33 | 34 | ### See Also 35 | 36 | - [npm run-script](/cli/v6/commands/npm-run-script) 37 | - [npm scripts](/cli/v6/using-npm/scripts) 38 | - [npm start](/cli/v6/commands/npm-start) 39 | - [npm restart](/cli/v6/commands/npm-restart) 40 | - [npm stop](/cli/v6/commands/npm-stop) 41 | -------------------------------------------------------------------------------- /content/cli/v6/commands/npm-whoami.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-whoami 3 | section: 1 4 | description: Display npm username 5 | github_repo: npm/cli 6 | github_branch: release/v6 7 | github_path: docs/content/commands/npm-whoami.md 8 | redirect_from: 9 | - /cli-documentation/v6/cli-commands/npm-whoami 10 | - /cli-documentation/v6/cli-commands/whoami 11 | - /cli-documentation/v6/commands/npm-whoami 12 | - /cli-documentation/v6/commands/whoami 13 | - /cli-documentation/v6/npm-whoami 14 | - /cli-documentation/v6/whoami 15 | - /cli/v6/cli-commands/npm-whoami 16 | - /cli/v6/cli-commands/whoami 17 | - /cli/v6/commands/whoami 18 | - /cli/v6/npm-whoami 19 | - /cli/v6/whoami 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm whoami [--registry ] 26 | ``` 27 | 28 | ### Description 29 | 30 | Print the `username` config to standard output. 31 | 32 | ### See Also 33 | 34 | - [npm config](/cli/v6/commands/npm-config) 35 | - [npmrc](/cli/v6/configuring-npm/npmrc) 36 | - [npm adduser](/cli/v6/commands/npm-adduser) 37 | -------------------------------------------------------------------------------- /content/cli/v6/configuring-npm/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Configuring npm 3 | shortName: Configuring 4 | github_repo: npm/cli 5 | github_branch: release/v6 6 | github_path: docs/nav.yml 7 | redirect_from: 8 | - /cli-documentation/v6/configuring-npm 9 | - /cli-documentation/v6/configuring-npm/index 10 | - /cli-documentation/v6/files 11 | - /cli-documentation/v6/files/index 12 | - /cli/v6/configuring-npm/index 13 | - /cli/v6/files 14 | - /cli/v6/files/index 15 | --- 16 | 17 | 18 | -------------------------------------------------------------------------------- /content/cli/v6/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm CLI 3 | shortName: CLI 4 | github_repo: npm/cli 5 | github_branch: release/v6 6 | github_path: docs/nav.yml 7 | redirect_from: 8 | - /cli-documentation/v6 9 | - /cli-documentation/v6/index 10 | - /cli/v6/index 11 | --- 12 | 13 | 14 | -------------------------------------------------------------------------------- /content/cli/v6/using-npm/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Using npm 3 | shortName: Using 4 | github_repo: npm/cli 5 | github_branch: release/v6 6 | github_path: docs/nav.yml 7 | redirect_from: 8 | - /cli-documentation/v6/misc 9 | - /cli-documentation/v6/misc/index 10 | - /cli-documentation/v6/using-npm 11 | - /cli-documentation/v6/using-npm/index 12 | - /cli/v6/misc 13 | - /cli/v6/misc/index 14 | - /cli/v6/using-npm/index 15 | --- 16 | 17 | 18 | -------------------------------------------------------------------------------- /content/cli/v7/commands/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: CLI Commands 3 | shortName: Commands 4 | github_repo: npm/cli 5 | github_branch: release/v7 6 | github_path: docs/nav.yml 7 | redirect_from: 8 | - /cli-documentation/v7/cli-commands 9 | - /cli-documentation/v7/cli-commands/index 10 | - /cli-documentation/v7/commands 11 | - /cli-documentation/v7/commands/index 12 | - /cli/v7/cli-commands 13 | - /cli/v7/cli-commands/index 14 | - /cli/v7/commands/index 15 | --- 16 | 17 | 18 | -------------------------------------------------------------------------------- /content/cli/v7/commands/npm-bin.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-bin 3 | section: 1 4 | description: Display npm bin folder 5 | github_repo: npm/cli 6 | github_branch: release/v7 7 | github_path: docs/content/commands/npm-bin.md 8 | redirect_from: 9 | - /cli-documentation/v7/bin 10 | - /cli-documentation/v7/cli-commands/bin 11 | - /cli-documentation/v7/cli-commands/npm-bin 12 | - /cli-documentation/v7/commands/bin 13 | - /cli-documentation/v7/commands/npm-bin 14 | - /cli-documentation/v7/npm-bin 15 | - /cli/v7/bin 16 | - /cli/v7/cli-commands/bin 17 | - /cli/v7/cli-commands/npm-bin 18 | - /cli/v7/commands/bin 19 | - /cli/v7/npm-bin 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm bin [-g|--global] 26 | ``` 27 | 28 | Note: This command is unaware of workspaces. 29 | 30 | ### Description 31 | 32 | Print the folder where npm will install executables. 33 | 34 | ### Configuration 35 | 36 | #### `global` 37 | 38 | - Default: false 39 | - Type: Boolean 40 | 41 | Operates in "global" mode, so that packages are installed into the `prefix` folder instead of the current working directory. See [folders](/cli/v7/configuring-npm/folders) for more on the differences in behavior. 42 | 43 | - packages are installed into the `{prefix}/lib/node_modules` folder, instead of the current working directory. 44 | - bin files are linked to `{prefix}/bin` 45 | - man pages are linked to `{prefix}/share/man` 46 | 47 | ### See Also 48 | 49 | - [npm prefix](/cli/v7/commands/npm-prefix) 50 | - [npm root](/cli/v7/commands/npm-root) 51 | - [npm folders](/cli/v7/configuring-npm/folders) 52 | - [npm config](/cli/v7/commands/npm-config) 53 | - [npmrc](/cli/v7/configuring-npm/npmrc) 54 | -------------------------------------------------------------------------------- /content/cli/v7/commands/npm-completion.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-completion 3 | section: 1 4 | description: Tab Completion for npm 5 | github_repo: npm/cli 6 | github_branch: release/v7 7 | github_path: docs/content/commands/npm-completion.md 8 | redirect_from: 9 | - /cli-documentation/v7/cli-commands/completion 10 | - /cli-documentation/v7/cli-commands/npm-completion 11 | - /cli-documentation/v7/commands/completion 12 | - /cli-documentation/v7/commands/npm-completion 13 | - /cli-documentation/v7/completion 14 | - /cli-documentation/v7/npm-completion 15 | - /cli/v7/cli-commands/completion 16 | - /cli/v7/cli-commands/npm-completion 17 | - /cli/v7/commands/completion 18 | - /cli/v7/completion 19 | - /cli/v7/npm-completion 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | source <(npm completion) 26 | ``` 27 | 28 | Note: This command is unaware of workspaces. 29 | 30 | ### Description 31 | 32 | Enables tab-completion in all npm commands. 33 | 34 | The synopsis above loads the completions into your current shell. Adding it to your ~/.bashrc or ~/.zshrc will make the completions available everywhere: 35 | 36 | ```bash 37 | npm completion >> ~/.bashrc 38 | npm completion >> ~/.zshrc 39 | ``` 40 | 41 | You may of course also pipe the output of `npm completion` to a file such as `/usr/local/etc/bash_completion.d/npm` or `/etc/bash_completion.d/npm` if you have a system that will read that file for you. 42 | 43 | When `COMP_CWORD`, `COMP_LINE`, and `COMP_POINT` are defined in the environment, `npm completion` acts in "plumbing mode", and outputs completions based on the arguments. 44 | 45 | ### See Also 46 | 47 | - [npm developers](/cli/v7/using-npm/developers) 48 | - [npm](/cli/v7/commands/npm) 49 | -------------------------------------------------------------------------------- /content/cli/v7/commands/npm-help-search.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-help-search 3 | section: 1 4 | description: Search npm help documentation 5 | github_repo: npm/cli 6 | github_branch: release/v7 7 | github_path: docs/content/commands/npm-help-search.md 8 | redirect_from: 9 | - /cli-documentation/v7/cli-commands/help-search 10 | - /cli-documentation/v7/cli-commands/npm-help-search 11 | - /cli-documentation/v7/commands/help-search 12 | - /cli-documentation/v7/commands/npm-help-search 13 | - /cli-documentation/v7/help-search 14 | - /cli-documentation/v7/npm-help-search 15 | - /cli/v7/cli-commands/help-search 16 | - /cli/v7/cli-commands/npm-help-search 17 | - /cli/v7/commands/help-search 18 | - /cli/v7/help-search 19 | - /cli/v7/npm-help-search 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm help-search 26 | ``` 27 | 28 | Note: This command is unaware of workspaces. 29 | 30 | ### Description 31 | 32 | This command will search the npm markdown documentation files for the terms provided, and then list the results, sorted by relevance. 33 | 34 | If only one result is found, then it will show that help topic. 35 | 36 | If the argument to `npm help` is not a known help topic, then it will call `help-search`. It is rarely if ever necessary to call this command directly. 37 | 38 | ### Configuration 39 | 40 | #### `long` 41 | 42 | - Default: false 43 | - Type: Boolean 44 | 45 | Show extended information in `ls`, `search`, and `help-search`. 46 | 47 | ### See Also 48 | 49 | - [npm](/cli/v7/commands/npm) 50 | - [npm help](/cli/v7/commands/npm-help) 51 | -------------------------------------------------------------------------------- /content/cli/v7/commands/npm-ping.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-ping 3 | section: 1 4 | description: Ping npm registry 5 | github_repo: npm/cli 6 | github_branch: release/v7 7 | github_path: docs/content/commands/npm-ping.md 8 | redirect_from: 9 | - /cli-documentation/v7/cli-commands/npm-ping 10 | - /cli-documentation/v7/cli-commands/ping 11 | - /cli-documentation/v7/commands/npm-ping 12 | - /cli-documentation/v7/commands/ping 13 | - /cli-documentation/v7/npm-ping 14 | - /cli-documentation/v7/ping 15 | - /cli/v7/cli-commands/npm-ping 16 | - /cli/v7/cli-commands/ping 17 | - /cli/v7/commands/ping 18 | - /cli/v7/npm-ping 19 | - /cli/v7/ping 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm ping [--registry ] 26 | ``` 27 | 28 | Note: This command is unaware of workspaces. 29 | 30 | ### Description 31 | 32 | Ping the configured or given npm registry and verify authentication. If it works it will output something like: 33 | 34 | ```bash 35 | Ping success: {*Details about registry*} 36 | ``` 37 | 38 | otherwise you will get: 39 | 40 | ```bash 41 | Ping error: {*Detail about error} 42 | ``` 43 | 44 | ### Configuration 45 | 46 | #### `registry` 47 | 48 | - Default: "https://registry.npmjs.org/" 49 | - Type: URL 50 | 51 | The base URL of the npm registry. 52 | 53 | ### See Also 54 | 55 | - [npm doctor](/cli/v7/commands/npm-doctor) 56 | - [npm config](/cli/v7/commands/npm-config) 57 | - [npmrc](/cli/v7/configuring-npm/npmrc) 58 | -------------------------------------------------------------------------------- /content/cli/v7/commands/npm-stars.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-stars 3 | section: 1 4 | description: View packages marked as favorites 5 | github_repo: npm/cli 6 | github_branch: release/v7 7 | github_path: docs/content/commands/npm-stars.md 8 | redirect_from: 9 | - /cli-documentation/v7/cli-commands/npm-stars 10 | - /cli-documentation/v7/cli-commands/stars 11 | - /cli-documentation/v7/commands/npm-stars 12 | - /cli-documentation/v7/commands/stars 13 | - /cli-documentation/v7/npm-stars 14 | - /cli-documentation/v7/stars 15 | - /cli/v7/cli-commands/npm-stars 16 | - /cli/v7/cli-commands/stars 17 | - /cli/v7/commands/stars 18 | - /cli/v7/npm-stars 19 | - /cli/v7/stars 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm stars [] 26 | ``` 27 | 28 | Note: This command is unaware of workspaces. 29 | 30 | ### Description 31 | 32 | If you have starred a lot of neat things and want to find them again quickly this command lets you do just that. 33 | 34 | You may also want to see your friend's favorite packages, in this case you will most certainly enjoy this command. 35 | 36 | ### Configuration 37 | 38 | #### `registry` 39 | 40 | - Default: "https://registry.npmjs.org/" 41 | - Type: URL 42 | 43 | The base URL of the npm registry. 44 | 45 | ### See Also 46 | 47 | - [npm star](/cli/v7/commands/npm-star) 48 | - [npm unstar](/cli/v7/commands/npm-unstar) 49 | - [npm view](/cli/v7/commands/npm-view) 50 | - [npm whoami](/cli/v7/commands/npm-whoami) 51 | - [npm adduser](/cli/v7/commands/npm-adduser) 52 | -------------------------------------------------------------------------------- /content/cli/v7/commands/npm-whoami.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-whoami 3 | section: 1 4 | description: Display npm username 5 | github_repo: npm/cli 6 | github_branch: release/v7 7 | github_path: docs/content/commands/npm-whoami.md 8 | redirect_from: 9 | - /cli-documentation/v7/cli-commands/npm-whoami 10 | - /cli-documentation/v7/cli-commands/whoami 11 | - /cli-documentation/v7/commands/npm-whoami 12 | - /cli-documentation/v7/commands/whoami 13 | - /cli-documentation/v7/npm-whoami 14 | - /cli-documentation/v7/whoami 15 | - /cli/v7/cli-commands/npm-whoami 16 | - /cli/v7/cli-commands/whoami 17 | - /cli/v7/commands/whoami 18 | - /cli/v7/npm-whoami 19 | - /cli/v7/whoami 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm whoami [--registry ] 26 | ``` 27 | 28 | Note: This command is unaware of workspaces. 29 | 30 | ### Description 31 | 32 | Display the npm username of the currently logged-in user. 33 | 34 | If logged into a registry that provides token-based authentication, then connect to the `/-/whoami` registry endpoint to find the username associated with the token, and print to standard output. 35 | 36 | If logged into a registry that uses Basic Auth, then simply print the `username` portion of the authentication string. 37 | 38 | ### Configuration 39 | 40 | #### `registry` 41 | 42 | - Default: "https://registry.npmjs.org/" 43 | - Type: URL 44 | 45 | The base URL of the npm registry. 46 | 47 | ### See Also 48 | 49 | - [npm config](/cli/v7/commands/npm-config) 50 | - [npmrc](/cli/v7/configuring-npm/npmrc) 51 | - [npm adduser](/cli/v7/commands/npm-adduser) 52 | -------------------------------------------------------------------------------- /content/cli/v7/configuring-npm/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Configuring npm 3 | shortName: Configuring 4 | github_repo: npm/cli 5 | github_branch: release/v7 6 | github_path: docs/nav.yml 7 | redirect_from: 8 | - /cli-documentation/v7/configuring-npm 9 | - /cli-documentation/v7/configuring-npm/index 10 | - /cli-documentation/v7/files 11 | - /cli-documentation/v7/files/index 12 | - /cli/v7/configuring-npm/index 13 | - /cli/v7/files 14 | - /cli/v7/files/index 15 | --- 16 | 17 | 18 | -------------------------------------------------------------------------------- /content/cli/v7/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm CLI 3 | shortName: CLI 4 | github_repo: npm/cli 5 | github_branch: release/v7 6 | github_path: docs/nav.yml 7 | redirect_from: 8 | - /cli-documentation/v7 9 | - /cli-documentation/v7/index 10 | - /cli/v7/index 11 | --- 12 | 13 | 14 | -------------------------------------------------------------------------------- /content/cli/v7/using-npm/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Using npm 3 | shortName: Using 4 | github_repo: npm/cli 5 | github_branch: release/v7 6 | github_path: docs/nav.yml 7 | redirect_from: 8 | - /cli-documentation/v7/misc 9 | - /cli-documentation/v7/misc/index 10 | - /cli-documentation/v7/using-npm 11 | - /cli-documentation/v7/using-npm/index 12 | - /cli/v7/misc 13 | - /cli/v7/misc/index 14 | - /cli/v7/using-npm/index 15 | --- 16 | 17 | 18 | -------------------------------------------------------------------------------- /content/cli/v8/commands/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: CLI Commands 3 | shortName: Commands 4 | github_repo: npm/cli 5 | github_branch: release/v8 6 | github_path: docs/lib/content/nav.yml 7 | redirect_from: 8 | - /cli-documentation/v8/cli-commands 9 | - /cli-documentation/v8/cli-commands/index 10 | - /cli-documentation/v8/commands 11 | - /cli-documentation/v8/commands/index 12 | - /cli/v8/cli-commands 13 | - /cli/v8/cli-commands/index 14 | - /cli/v8/commands/index 15 | --- 16 | 17 | 18 | -------------------------------------------------------------------------------- /content/cli/v8/commands/npm-bin.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-bin 3 | section: 1 4 | description: Display npm bin folder 5 | github_repo: npm/cli 6 | github_branch: release/v8 7 | github_path: docs/lib/content/commands/npm-bin.md 8 | redirect_from: 9 | - /cli-documentation/v8/bin 10 | - /cli-documentation/v8/cli-commands/bin 11 | - /cli-documentation/v8/cli-commands/npm-bin 12 | - /cli-documentation/v8/commands/bin 13 | - /cli-documentation/v8/commands/npm-bin 14 | - /cli-documentation/v8/npm-bin 15 | - /cli/v8/bin 16 | - /cli/v8/cli-commands/bin 17 | - /cli/v8/cli-commands/npm-bin 18 | - /cli/v8/commands/bin 19 | - /cli/v8/npm-bin 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm bin 26 | ``` 27 | 28 | Note: This command is unaware of workspaces. 29 | 30 | ### Description 31 | 32 | Print the folder where npm will install executables. 33 | 34 | ### Configuration 35 | 36 | #### `global` 37 | 38 | - Default: false 39 | - Type: Boolean 40 | 41 | Operates in "global" mode, so that packages are installed into the `prefix` folder instead of the current working directory. See [folders](/cli/v8/configuring-npm/folders) for more on the differences in behavior. 42 | 43 | - packages are installed into the `{prefix}/lib/node_modules` folder, instead of the current working directory. 44 | - bin files are linked to `{prefix}/bin` 45 | - man pages are linked to `{prefix}/share/man` 46 | 47 | ### See Also 48 | 49 | - [npm prefix](/cli/v8/commands/npm-prefix) 50 | - [npm root](/cli/v8/commands/npm-root) 51 | - [npm folders](/cli/v8/configuring-npm/folders) 52 | - [npm config](/cli/v8/commands/npm-config) 53 | - [npmrc](/cli/v8/configuring-npm/npmrc) 54 | -------------------------------------------------------------------------------- /content/cli/v8/commands/npm-completion.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-completion 3 | section: 1 4 | description: Tab Completion for npm 5 | github_repo: npm/cli 6 | github_branch: release/v8 7 | github_path: docs/lib/content/commands/npm-completion.md 8 | redirect_from: 9 | - /cli-documentation/v8/cli-commands/completion 10 | - /cli-documentation/v8/cli-commands/npm-completion 11 | - /cli-documentation/v8/commands/completion 12 | - /cli-documentation/v8/commands/npm-completion 13 | - /cli-documentation/v8/completion 14 | - /cli-documentation/v8/npm-completion 15 | - /cli/v8/cli-commands/completion 16 | - /cli/v8/cli-commands/npm-completion 17 | - /cli/v8/commands/completion 18 | - /cli/v8/completion 19 | - /cli/v8/npm-completion 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm completion 26 | ``` 27 | 28 | Note: This command is unaware of workspaces. 29 | 30 | ### Description 31 | 32 | Enables tab-completion in all npm commands. 33 | 34 | The synopsis above loads the completions into your current shell. Adding it to your ~/.bashrc or ~/.zshrc will make the completions available everywhere: 35 | 36 | ```bash 37 | npm completion >> ~/.bashrc 38 | npm completion >> ~/.zshrc 39 | ``` 40 | 41 | You may of course also pipe the output of `npm completion` to a file such as `/usr/local/etc/bash_completion.d/npm` or `/etc/bash_completion.d/npm` if you have a system that will read that file for you. 42 | 43 | When `COMP_CWORD`, `COMP_LINE`, and `COMP_POINT` are defined in the environment, `npm completion` acts in "plumbing mode", and outputs completions based on the arguments. 44 | 45 | ### See Also 46 | 47 | - [npm developers](/cli/v8/using-npm/developers) 48 | - [npm](/cli/v8/commands/npm) 49 | -------------------------------------------------------------------------------- /content/cli/v8/commands/npm-help-search.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-help-search 3 | section: 1 4 | description: Search npm help documentation 5 | github_repo: npm/cli 6 | github_branch: release/v8 7 | github_path: docs/lib/content/commands/npm-help-search.md 8 | redirect_from: 9 | - /cli-documentation/v8/cli-commands/help-search 10 | - /cli-documentation/v8/cli-commands/npm-help-search 11 | - /cli-documentation/v8/commands/help-search 12 | - /cli-documentation/v8/commands/npm-help-search 13 | - /cli-documentation/v8/help-search 14 | - /cli-documentation/v8/npm-help-search 15 | - /cli/v8/cli-commands/help-search 16 | - /cli/v8/cli-commands/npm-help-search 17 | - /cli/v8/commands/help-search 18 | - /cli/v8/help-search 19 | - /cli/v8/npm-help-search 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm help-search 26 | ``` 27 | 28 | Note: This command is unaware of workspaces. 29 | 30 | ### Description 31 | 32 | This command will search the npm markdown documentation files for the terms provided, and then list the results, sorted by relevance. 33 | 34 | If only one result is found, then it will show that help topic. 35 | 36 | If the argument to `npm help` is not a known help topic, then it will call `help-search`. It is rarely if ever necessary to call this command directly. 37 | 38 | ### Configuration 39 | 40 | #### `long` 41 | 42 | - Default: false 43 | - Type: Boolean 44 | 45 | Show extended information in `ls`, `search`, and `help-search`. 46 | 47 | ### See Also 48 | 49 | - [npm](/cli/v8/commands/npm) 50 | - [npm help](/cli/v8/commands/npm-help) 51 | -------------------------------------------------------------------------------- /content/cli/v8/commands/npm-ping.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-ping 3 | section: 1 4 | description: Ping npm registry 5 | github_repo: npm/cli 6 | github_branch: release/v8 7 | github_path: docs/lib/content/commands/npm-ping.md 8 | redirect_from: 9 | - /cli-documentation/v8/cli-commands/npm-ping 10 | - /cli-documentation/v8/cli-commands/ping 11 | - /cli-documentation/v8/commands/npm-ping 12 | - /cli-documentation/v8/commands/ping 13 | - /cli-documentation/v8/npm-ping 14 | - /cli-documentation/v8/ping 15 | - /cli/v8/cli-commands/npm-ping 16 | - /cli/v8/cli-commands/ping 17 | - /cli/v8/commands/ping 18 | - /cli/v8/npm-ping 19 | - /cli/v8/ping 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm ping 26 | ``` 27 | 28 | Note: This command is unaware of workspaces. 29 | 30 | ### Description 31 | 32 | Ping the configured or given npm registry and verify authentication. If it works it will output something like: 33 | 34 | ```bash 35 | npm notice PING https://registry.npmjs.org/ 36 | npm notice PONG 255ms 37 | ``` 38 | 39 | otherwise you will get an error: 40 | 41 | ```bash 42 | npm notice PING http://foo.com/ 43 | npm ERR! code E404 44 | npm ERR! 404 Not Found - GET http://www.foo.com/-/ping?write=true 45 | ``` 46 | 47 | ### Configuration 48 | 49 | #### `registry` 50 | 51 | - Default: "https://registry.npmjs.org/" 52 | - Type: URL 53 | 54 | The base URL of the npm registry. 55 | 56 | ### See Also 57 | 58 | - [npm doctor](/cli/v8/commands/npm-doctor) 59 | - [npm config](/cli/v8/commands/npm-config) 60 | - [npmrc](/cli/v8/configuring-npm/npmrc) 61 | -------------------------------------------------------------------------------- /content/cli/v8/commands/npm-stars.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-stars 3 | section: 1 4 | description: View packages marked as favorites 5 | github_repo: npm/cli 6 | github_branch: release/v8 7 | github_path: docs/lib/content/commands/npm-stars.md 8 | redirect_from: 9 | - /cli-documentation/v8/cli-commands/npm-stars 10 | - /cli-documentation/v8/cli-commands/stars 11 | - /cli-documentation/v8/commands/npm-stars 12 | - /cli-documentation/v8/commands/stars 13 | - /cli-documentation/v8/npm-stars 14 | - /cli-documentation/v8/stars 15 | - /cli/v8/cli-commands/npm-stars 16 | - /cli/v8/cli-commands/stars 17 | - /cli/v8/commands/stars 18 | - /cli/v8/npm-stars 19 | - /cli/v8/stars 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm stars [] 26 | ``` 27 | 28 | Note: This command is unaware of workspaces. 29 | 30 | ### Description 31 | 32 | If you have starred a lot of neat things and want to find them again quickly this command lets you do just that. 33 | 34 | You may also want to see your friend's favorite packages, in this case you will most certainly enjoy this command. 35 | 36 | ### Configuration 37 | 38 | #### `registry` 39 | 40 | - Default: "https://registry.npmjs.org/" 41 | - Type: URL 42 | 43 | The base URL of the npm registry. 44 | 45 | ### See Also 46 | 47 | - [npm star](/cli/v8/commands/npm-star) 48 | - [npm unstar](/cli/v8/commands/npm-unstar) 49 | - [npm view](/cli/v8/commands/npm-view) 50 | - [npm whoami](/cli/v8/commands/npm-whoami) 51 | - [npm adduser](/cli/v8/commands/npm-adduser) 52 | -------------------------------------------------------------------------------- /content/cli/v8/commands/npm-whoami.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-whoami 3 | section: 1 4 | description: Display npm username 5 | github_repo: npm/cli 6 | github_branch: release/v8 7 | github_path: docs/lib/content/commands/npm-whoami.md 8 | redirect_from: 9 | - /cli-documentation/v8/cli-commands/npm-whoami 10 | - /cli-documentation/v8/cli-commands/whoami 11 | - /cli-documentation/v8/commands/npm-whoami 12 | - /cli-documentation/v8/commands/whoami 13 | - /cli-documentation/v8/npm-whoami 14 | - /cli-documentation/v8/whoami 15 | - /cli/v8/cli-commands/npm-whoami 16 | - /cli/v8/cli-commands/whoami 17 | - /cli/v8/commands/whoami 18 | - /cli/v8/npm-whoami 19 | - /cli/v8/whoami 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm whoami 26 | ``` 27 | 28 | Note: This command is unaware of workspaces. 29 | 30 | ### Description 31 | 32 | Display the npm username of the currently logged-in user. 33 | 34 | If logged into a registry that provides token-based authentication, then connect to the `/-/whoami` registry endpoint to find the username associated with the token, and print to standard output. 35 | 36 | If logged into a registry that uses Basic Auth, then simply print the `username` portion of the authentication string. 37 | 38 | ### Configuration 39 | 40 | #### `registry` 41 | 42 | - Default: "https://registry.npmjs.org/" 43 | - Type: URL 44 | 45 | The base URL of the npm registry. 46 | 47 | ### See Also 48 | 49 | - [npm config](/cli/v8/commands/npm-config) 50 | - [npmrc](/cli/v8/configuring-npm/npmrc) 51 | - [npm adduser](/cli/v8/commands/npm-adduser) 52 | -------------------------------------------------------------------------------- /content/cli/v8/configuring-npm/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Configuring npm 3 | shortName: Configuring 4 | github_repo: npm/cli 5 | github_branch: release/v8 6 | github_path: docs/lib/content/nav.yml 7 | redirect_from: 8 | - /cli-documentation/v8/configuring-npm 9 | - /cli-documentation/v8/configuring-npm/index 10 | - /cli-documentation/v8/files 11 | - /cli-documentation/v8/files/index 12 | - /cli/v8/configuring-npm/index 13 | - /cli/v8/files 14 | - /cli/v8/files/index 15 | --- 16 | 17 | 18 | -------------------------------------------------------------------------------- /content/cli/v8/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm CLI 3 | shortName: CLI 4 | github_repo: npm/cli 5 | github_branch: release/v8 6 | github_path: docs/lib/content/nav.yml 7 | redirect_from: 8 | - /cli-documentation/v8 9 | - /cli-documentation/v8/index 10 | - /cli/v8/index 11 | --- 12 | 13 | 14 | -------------------------------------------------------------------------------- /content/cli/v8/using-npm/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Using npm 3 | shortName: Using 4 | github_repo: npm/cli 5 | github_branch: release/v8 6 | github_path: docs/lib/content/nav.yml 7 | redirect_from: 8 | - /cli-documentation/v8/misc 9 | - /cli-documentation/v8/misc/index 10 | - /cli-documentation/v8/using-npm 11 | - /cli-documentation/v8/using-npm/index 12 | - /cli/v8/misc 13 | - /cli/v8/misc/index 14 | - /cli/v8/using-npm/index 15 | --- 16 | 17 | 18 | -------------------------------------------------------------------------------- /content/cli/v9/commands/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: CLI Commands 3 | shortName: Commands 4 | github_repo: npm/cli 5 | github_branch: release/v9 6 | github_path: docs/lib/content/nav.yml 7 | redirect_from: 8 | - /cli-documentation/v9/cli-commands 9 | - /cli-documentation/v9/cli-commands/index 10 | - /cli-documentation/v9/commands 11 | - /cli-documentation/v9/commands/index 12 | - /cli/v9/cli-commands 13 | - /cli/v9/cli-commands/index 14 | - /cli/v9/commands/index 15 | --- 16 | 17 | 18 | -------------------------------------------------------------------------------- /content/cli/v9/commands/npm-completion.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-completion 3 | section: 1 4 | description: Tab Completion for npm 5 | github_repo: npm/cli 6 | github_branch: release/v9 7 | github_path: docs/lib/content/commands/npm-completion.md 8 | redirect_from: 9 | - /cli-documentation/v9/cli-commands/completion 10 | - /cli-documentation/v9/cli-commands/npm-completion 11 | - /cli-documentation/v9/commands/completion 12 | - /cli-documentation/v9/commands/npm-completion 13 | - /cli-documentation/v9/completion 14 | - /cli-documentation/v9/npm-completion 15 | - /cli/v9/cli-commands/completion 16 | - /cli/v9/cli-commands/npm-completion 17 | - /cli/v9/commands/completion 18 | - /cli/v9/completion 19 | - /cli/v9/npm-completion 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm completion 26 | ``` 27 | 28 | Note: This command is unaware of workspaces. 29 | 30 | ### Description 31 | 32 | Enables tab-completion in all npm commands. 33 | 34 | The synopsis above loads the completions into your current shell. Adding it to your ~/.bashrc or ~/.zshrc will make the completions available everywhere: 35 | 36 | ```bash 37 | npm completion >> ~/.bashrc 38 | npm completion >> ~/.zshrc 39 | ``` 40 | 41 | You may of course also pipe the output of `npm completion` to a file such as `/usr/local/etc/bash_completion.d/npm` or `/etc/bash_completion.d/npm` if you have a system that will read that file for you. 42 | 43 | When `COMP_CWORD`, `COMP_LINE`, and `COMP_POINT` are defined in the environment, `npm completion` acts in "plumbing mode", and outputs completions based on the arguments. 44 | 45 | ### See Also 46 | 47 | - [npm developers](/cli/v9/using-npm/developers) 48 | - [npm](/cli/v9/commands/npm) 49 | -------------------------------------------------------------------------------- /content/cli/v9/commands/npm-help-search.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-help-search 3 | section: 1 4 | description: Search npm help documentation 5 | github_repo: npm/cli 6 | github_branch: release/v9 7 | github_path: docs/lib/content/commands/npm-help-search.md 8 | redirect_from: 9 | - /cli-documentation/v9/cli-commands/help-search 10 | - /cli-documentation/v9/cli-commands/npm-help-search 11 | - /cli-documentation/v9/commands/help-search 12 | - /cli-documentation/v9/commands/npm-help-search 13 | - /cli-documentation/v9/help-search 14 | - /cli-documentation/v9/npm-help-search 15 | - /cli/v9/cli-commands/help-search 16 | - /cli/v9/cli-commands/npm-help-search 17 | - /cli/v9/commands/help-search 18 | - /cli/v9/help-search 19 | - /cli/v9/npm-help-search 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm help-search 26 | ``` 27 | 28 | Note: This command is unaware of workspaces. 29 | 30 | ### Description 31 | 32 | This command will search the npm markdown documentation files for the terms provided, and then list the results, sorted by relevance. 33 | 34 | If only one result is found, then it will show that help topic. 35 | 36 | If the argument to `npm help` is not a known help topic, then it will call `help-search`. It is rarely if ever necessary to call this command directly. 37 | 38 | ### Configuration 39 | 40 | #### `long` 41 | 42 | - Default: false 43 | - Type: Boolean 44 | 45 | Show extended information in `ls`, `search`, and `help-search`. 46 | 47 | ### See Also 48 | 49 | - [npm](/cli/v9/commands/npm) 50 | - [npm help](/cli/v9/commands/npm-help) 51 | -------------------------------------------------------------------------------- /content/cli/v9/commands/npm-ping.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-ping 3 | section: 1 4 | description: Ping npm registry 5 | github_repo: npm/cli 6 | github_branch: release/v9 7 | github_path: docs/lib/content/commands/npm-ping.md 8 | redirect_from: 9 | - /cli-documentation/v9/cli-commands/npm-ping 10 | - /cli-documentation/v9/cli-commands/ping 11 | - /cli-documentation/v9/commands/npm-ping 12 | - /cli-documentation/v9/commands/ping 13 | - /cli-documentation/v9/npm-ping 14 | - /cli-documentation/v9/ping 15 | - /cli/v9/cli-commands/npm-ping 16 | - /cli/v9/cli-commands/ping 17 | - /cli/v9/commands/ping 18 | - /cli/v9/npm-ping 19 | - /cli/v9/ping 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm ping 26 | ``` 27 | 28 | Note: This command is unaware of workspaces. 29 | 30 | ### Description 31 | 32 | Ping the configured or given npm registry and verify authentication. If it works it will output something like: 33 | 34 | ```bash 35 | npm notice PING https://registry.npmjs.org/ 36 | npm notice PONG 255ms 37 | ``` 38 | 39 | otherwise you will get an error: 40 | 41 | ```bash 42 | npm notice PING http://foo.com/ 43 | npm ERR! code E404 44 | npm ERR! 404 Not Found - GET http://www.foo.com/-/ping?write=true 45 | ``` 46 | 47 | ### Configuration 48 | 49 | #### `registry` 50 | 51 | - Default: "https://registry.npmjs.org/" 52 | - Type: URL 53 | 54 | The base URL of the npm registry. 55 | 56 | ### See Also 57 | 58 | - [npm doctor](/cli/v9/commands/npm-doctor) 59 | - [npm config](/cli/v9/commands/npm-config) 60 | - [npmrc](/cli/v9/configuring-npm/npmrc) 61 | -------------------------------------------------------------------------------- /content/cli/v9/commands/npm-stars.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-stars 3 | section: 1 4 | description: View packages marked as favorites 5 | github_repo: npm/cli 6 | github_branch: release/v9 7 | github_path: docs/lib/content/commands/npm-stars.md 8 | redirect_from: 9 | - /cli-documentation/v9/cli-commands/npm-stars 10 | - /cli-documentation/v9/cli-commands/stars 11 | - /cli-documentation/v9/commands/npm-stars 12 | - /cli-documentation/v9/commands/stars 13 | - /cli-documentation/v9/npm-stars 14 | - /cli-documentation/v9/stars 15 | - /cli/v9/cli-commands/npm-stars 16 | - /cli/v9/cli-commands/stars 17 | - /cli/v9/commands/stars 18 | - /cli/v9/npm-stars 19 | - /cli/v9/stars 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm stars [] 26 | ``` 27 | 28 | Note: This command is unaware of workspaces. 29 | 30 | ### Description 31 | 32 | If you have starred a lot of neat things and want to find them again quickly this command lets you do just that. 33 | 34 | You may also want to see your friend's favorite packages, in this case you will most certainly enjoy this command. 35 | 36 | ### Configuration 37 | 38 | #### `registry` 39 | 40 | - Default: "https://registry.npmjs.org/" 41 | - Type: URL 42 | 43 | The base URL of the npm registry. 44 | 45 | ### See Also 46 | 47 | - [npm star](/cli/v9/commands/npm-star) 48 | - [npm unstar](/cli/v9/commands/npm-unstar) 49 | - [npm view](/cli/v9/commands/npm-view) 50 | - [npm whoami](/cli/v9/commands/npm-whoami) 51 | - [npm adduser](/cli/v9/commands/npm-adduser) 52 | -------------------------------------------------------------------------------- /content/cli/v9/commands/npm-whoami.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm-whoami 3 | section: 1 4 | description: Display npm username 5 | github_repo: npm/cli 6 | github_branch: release/v9 7 | github_path: docs/lib/content/commands/npm-whoami.md 8 | redirect_from: 9 | - /cli-documentation/v9/cli-commands/npm-whoami 10 | - /cli-documentation/v9/cli-commands/whoami 11 | - /cli-documentation/v9/commands/npm-whoami 12 | - /cli-documentation/v9/commands/whoami 13 | - /cli-documentation/v9/npm-whoami 14 | - /cli-documentation/v9/whoami 15 | - /cli/v9/cli-commands/npm-whoami 16 | - /cli/v9/cli-commands/whoami 17 | - /cli/v9/commands/whoami 18 | - /cli/v9/npm-whoami 19 | - /cli/v9/whoami 20 | --- 21 | 22 | ### Synopsis 23 | 24 | ```bash 25 | npm whoami 26 | ``` 27 | 28 | Note: This command is unaware of workspaces. 29 | 30 | ### Description 31 | 32 | Display the npm username of the currently logged-in user. 33 | 34 | If logged into a registry that provides token-based authentication, then connect to the `/-/whoami` registry endpoint to find the username associated with the token, and print to standard output. 35 | 36 | If logged into a registry that uses Basic Auth, then simply print the `username` portion of the authentication string. 37 | 38 | ### Configuration 39 | 40 | #### `registry` 41 | 42 | - Default: "https://registry.npmjs.org/" 43 | - Type: URL 44 | 45 | The base URL of the npm registry. 46 | 47 | ### See Also 48 | 49 | - [npm config](/cli/v9/commands/npm-config) 50 | - [npmrc](/cli/v9/configuring-npm/npmrc) 51 | - [npm adduser](/cli/v9/commands/npm-adduser) 52 | -------------------------------------------------------------------------------- /content/cli/v9/configuring-npm/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Configuring npm 3 | shortName: Configuring 4 | github_repo: npm/cli 5 | github_branch: release/v9 6 | github_path: docs/lib/content/nav.yml 7 | redirect_from: 8 | - /cli-documentation/v9/configuring-npm 9 | - /cli-documentation/v9/configuring-npm/index 10 | - /cli-documentation/v9/files 11 | - /cli-documentation/v9/files/index 12 | - /cli/v9/configuring-npm/index 13 | - /cli/v9/files 14 | - /cli/v9/files/index 15 | --- 16 | 17 | 18 | -------------------------------------------------------------------------------- /content/cli/v9/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm CLI 3 | shortName: CLI 4 | github_repo: npm/cli 5 | github_branch: release/v9 6 | github_path: docs/lib/content/nav.yml 7 | redirect_from: 8 | - /cli-documentation/v9 9 | - /cli-documentation/v9/index 10 | - /cli/v9/index 11 | --- 12 | 13 | 14 | -------------------------------------------------------------------------------- /content/cli/v9/using-npm/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Using npm 3 | shortName: Using 4 | github_repo: npm/cli 5 | github_branch: release/v9 6 | github_path: docs/lib/content/nav.yml 7 | redirect_from: 8 | - /cli-documentation/v9/misc 9 | - /cli-documentation/v9/misc/index 10 | - /cli-documentation/v9/using-npm 11 | - /cli-documentation/v9/using-npm/index 12 | - /cli/v9/misc 13 | - /cli/v9/misc/index 14 | - /cli/v9/using-npm/index 15 | --- 16 | 17 | 18 | -------------------------------------------------------------------------------- /content/getting-started/configuring-your-local-environment/about-npm-versions.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: About npm CLI versions 3 | slug: /about-npm-versions 4 | --- 5 | 6 | The npm command line interface (CLI) is released on a regular cadence. We recommend installing the release that supports your workflow: 7 | 8 | - [latest release](#the-latest-release-of-npm): the most recent stable version. 9 | 10 | ## The `latest` release of npm 11 | 12 | The `latest` release of npm is the most recent stable version. When you install Node.js, npm is automatically installed. However, npm is released more frequently than Node.js, so to install the latest stable version of npm, on the command line, run: 13 | 14 | ``` 15 | npm install npm@latest -g 16 | ``` 17 | -------------------------------------------------------------------------------- /content/getting-started/configuring-your-local-environment/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Configuring your local environment 3 | edit_on_github: false 4 | --- 5 | 6 | 7 | -------------------------------------------------------------------------------- /content/getting-started/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Getting started 3 | edit_on_github: false 4 | --- 5 | 6 | 7 | -------------------------------------------------------------------------------- /content/getting-started/managing-your-npm-user-account/changing-your-npm-username.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Changing your npm username 3 | --- 4 | 5 | It is not currently possible to change your npm username. You'll need to create a new account and migrate the data to the new account manually. 6 | 7 | 1. Create a [new user account](/creating-a-new-npm-user-account) with your desired username 8 | 2. [Transfer your packages](/transferring-a-package-from-a-user-account-to-another-user-account) to your new account. 9 | 3. If you are a member of any [organizations](/organizations), ask the organization administrator to [invite your new account to the organization](/adding-members-to-your-organization). 10 | 4. Delete your [original account](/deleting-your-npm-user-account). Note that this is permanent, and after 30 days, this account name is available for other people to claim. 11 | -------------------------------------------------------------------------------- /content/getting-started/managing-your-npm-user-account/deleting-your-npm-user-account.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Deleting your npm user account 3 | --- 4 | 5 | import shared from '~/shared.js' 6 | 7 | From the web, you can delete your npm user account. 8 | 9 | 1. <>{shared['user-login'].text} 10 | 11 | <>{shared['user-login'].image} 12 | 13 | 2. <>{shared['account-settings'].text} 14 | 15 | <>{shared['account-settings'].image} 16 | 17 | 3. On this page, you will find a button to delete your account. Click that. 18 | 19 | 20 | 21 | 4. You will now be presented with an overview of how many npm packages will be deleted and deprecated as part of your account deletion. If you agree with this, then enter your username and click "Delete this account". 22 | 23 | 24 | 25 | 5. You will be immediately logged out, and will not be able to log back in. 26 | 27 | In some cases, you will be presented with an error if we were unable to automatically delete your account. For example. if you are the sole owner of an organization you will need to add an additional owner before your account can be deleted. You will be presented clear instructions of what you will need to do in order to delete your account. 28 | 29 | <>If you are in doubt about deleting your account, {shared['contact-support'].text}. 30 | -------------------------------------------------------------------------------- /content/getting-started/managing-your-npm-user-account/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Managing your npm user account 3 | edit_on_github: false 4 | --- 5 | 6 | 7 | -------------------------------------------------------------------------------- /content/getting-started/managing-your-npm-user-account/requesting-your-data.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Requesting an export of your personal data 3 | edit_on_github: false 4 | --- 5 | 6 | You can export and review the metadata that npm stores about your personal account. The export is an archive containing the following information. 7 | 8 | 1. Your personal details such as username, email address, full name, linked Twitter / GitHub accounts, masked Personal Access Tokens (PAT) and the organisations that you are a member of. 9 | 2. Metadata of all the packages that you have access to. 10 | 3. Each individual version of packages that you have published to npm. 11 | 12 | ## How to request an export 13 | 14 | 1. Navigate to [npm support form](https://www.npmjs.com/support) 15 | 2. Select "Account and Billing issues" category 16 | 3. Select "Data export request" sub-category 17 | 18 | 19 | 20 | 4. Fill in the details and submit the form 21 | 22 | ## Retrieving the exported data 23 | 24 | After a request is placed our support team will review it and initiate an export on your behalf. Once the export process is complete you will receive an email with a link to an archive of your personal data. You must be authenticated to npmjs.com to download this archive. 25 | 26 | The download link will be available for 7 days, after which the exported data and the link is purged. 27 | -------------------------------------------------------------------------------- /content/getting-started/paying-for-your-npm-user-account/downgrading-to-a-free-user-account-plan.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Downgrading to a free user account plan 3 | --- 4 | 5 | import shared from '~/shared.js' 6 | 7 | 8 | 9 | **Note:** This article only applies to users of the public npm registry. 10 | 11 | 12 | 13 | If you have a paid user account, but no longer need private packages, you can downgrade your paid organization to a free organization. When you downgrade from a paid to a free organization, you will lose the ability to install and publish private packages at the end of your last paid billing cycle. Your private packages will _not_ be made publicly visible when you downgrade to a free plan. 14 | 15 | 1. <>{shared['user-login'].text} 16 | 17 | <>{shared['user-login'].image} 18 | 19 | 2. <>{shared['billing-info'].text} 20 | 21 | <>{shared['billing-info'].image} 22 | 23 | 3. <>{shared['billing-downgrade-selection'].text} 24 | 25 | <>{shared['billing-downgrade-selection'].image} 26 | 27 | 4. <>{shared['billing-downgrade-confirm'].text} 28 | 29 | <>{shared['billing-downgrade-confirm'].image} 30 | -------------------------------------------------------------------------------- /content/getting-started/paying-for-your-npm-user-account/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Paying for your npm user account 3 | edit_on_github: false 4 | --- 5 | 6 | 7 | -------------------------------------------------------------------------------- /content/getting-started/setting-up-your-npm-user-account/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Setting up your npm user account 3 | edit_on_github: false 4 | --- 5 | 6 | 7 | -------------------------------------------------------------------------------- /content/getting-started/troubleshooting/generating-and-locating-npm-debug.log-files.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Generating and locating npm-debug.log files 3 | redirect_from: 4 | - /generating-and-locating-npm-debug-log-files 5 | --- 6 | 7 | When a package fails to install or publish, the npm CLI will generate an `npm-debug.log` file. This log file can help you figure out what went wrong. 8 | 9 | If you need to generate a `npm-debug.log` file, you can run one of these commands. 10 | 11 | For installing packages: 12 | 13 | ``` 14 | npm install --timing 15 | ``` 16 | 17 | For publishing packages: 18 | 19 | ``` 20 | npm publish --timing 21 | ``` 22 | 23 | You can find the `npm-debug.log` file in your `.npm` directory. To find your `.npm` directory, use `npm config get cache`. 24 | 25 | If you use a CI environment, your logs are likely located elsewhere. For example, in Travis CI, you can find them in the `/home/travis/build` directory. 26 | -------------------------------------------------------------------------------- /content/getting-started/troubleshooting/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Troubleshooting 3 | edit_on_github: false 4 | --- 5 | 6 | 7 | -------------------------------------------------------------------------------- /content/header-nav.yml: -------------------------------------------------------------------------------- 1 | - title: npmjs.com 2 | url: https://npmjs.com/ 3 | - title: Status 4 | url: https://status.npmjs.com/ 5 | - title: Support 6 | url: https://npmjs.com/support/ 7 | -------------------------------------------------------------------------------- /content/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm Docs 3 | edit_on_github: false 4 | --- 5 | 6 | 7 | -------------------------------------------------------------------------------- /content/integrations/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Integrations 3 | edit_on_github: false 4 | --- 5 | 6 | 7 | -------------------------------------------------------------------------------- /content/integrations/integrating-npm-with-external-services/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Integrating npm with external services 3 | edit_on_github: false 4 | --- 5 | 6 | 7 | -------------------------------------------------------------------------------- /content/integrations/integrating-npm-with-external-services/revoking-access-tokens.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Revoking access tokens 3 | redirect_from: 4 | - /revoking-authentication-tokens 5 | --- 6 | 7 | To keep your account and packages secure, we strongly recommend revoking (deleting) tokens you no longer need or that have been compromised. You can revoke any token you have created. 8 | 9 | 1. To see a list of your tokens, on the command line, run: 10 | 11 | ``` 12 | npm token list 13 | ``` 14 | 15 | 2. In the tokens table, find and copy the ID of the token you want to delete. 16 | 17 | 3. On the command line, run the following command, replacing `123456` with the ID of the token you want to delete: 18 | 19 | ``` 20 | npm token delete 123456 21 | ``` 22 | 23 | npm will report `Removed 1 token` 24 | 25 | 4. To confirm that the token has been removed, run: 26 | 27 | ``` 28 | npm token list 29 | ``` 30 | 31 | 32 | 33 | **Note:** You must use the token ID to delete a token, not the truncated version of the token. In some cases, there may be a delay of up to an hour before a token is successfully revoked. 34 | 35 | 36 | -------------------------------------------------------------------------------- /content/organizations/creating-and-managing-organizations/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Creating and managing organizations 3 | redirect_from: 4 | - /orgs/creating-and-managing-orgs 5 | edit_on_github: false 6 | --- 7 | 8 | 9 | -------------------------------------------------------------------------------- /content/organizations/creating-and-managing-organizations/renaming-an-organization.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Renaming an organization 3 | redirect_from: 4 | - /renaming-an-org 5 | --- 6 | 7 | Organizations cannot be renamed from the website or command line interface. 8 | 9 | To rename an organization, as an organization owner, you must manually migrate your existing organization members, teams, and packages to a new organization, then [contact npm Support][contact-support] to have the outdated packages unpublished and the previous organization deleted. 10 | 11 | 1. [Create a new organization][org-create] with the name you want. If your old organization is on a paid plan, you must choose a paid plan for the new organization. 12 | 2. [Add the members][add-org-members] of your old organization to your new organization. 13 | 3. In your new organization, [create teams][create-teams] to match teams in your old organization. 14 | 4. Republish packages to the new organization by updating the package scope in its `package.json` file to match the new organization name and running `npm publish`. 15 | 5. In the new organization teams, [configure package access][pkg-access] to match team package access in your old organization. 16 | 6. [Contact npm Support][contact-support] to have the outdated packages unpublished and the previous organization deleted. 17 | 18 | [contact-support]: https://www.npmjs.com/support 19 | [org-create]: creating-an-organization 20 | [add-org-members]: adding-members-to-your-organization 21 | [create-teams]: creating-teams 22 | [pkg-access]: managing-team-access-to-packages 23 | -------------------------------------------------------------------------------- /content/organizations/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Organizations 3 | redirect_from: 4 | - /getting-started/working-with-orgs 5 | - /orgs 6 | --- 7 | 8 | <>Organizations allow teams of contributors to read and write public and private packages. Organizations are free when they publish public packages. When organizations publish private packages, an npm Teams subscription is required. For more information on npm Teams pricing, see our [products page](https://www.npmjs.com/pricing). 9 | 10 | 11 | -------------------------------------------------------------------------------- /content/organizations/managing-organization-members/accepting-or-rejecting-an-organization-invitation.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Accepting or rejecting an organization invitation 3 | redirect_from: 4 | - /accepting-or-rejecting-an-org-invitation 5 | --- 6 | 7 | ## Accepting an organization invitation 8 | 9 | If you receive an invitation to an organization, you have to accept the invitation over email to be added to the organization. 10 | 11 | You have the option to use a different email address than the one that received the invitation to join the organization. 12 | 13 | 1. Click the verification link in the organization invitation email. 14 | 15 | 2. You will be prompted to log into your npm user account. If you don't have an npm user account, you can sign up for one. 16 | 17 | 18 | 19 | ## Rejecting an organization invitation 20 | 21 | If you are invited to an organization that you do not want to join, you can let the invitation expire. Organization invitations expire after one week. 22 | -------------------------------------------------------------------------------- /content/organizations/managing-organization-members/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Managing organization members 3 | redirect_from: 4 | - /orgs/managing-org-members 5 | edit_on_github: false 6 | --- 7 | 8 | 9 | -------------------------------------------------------------------------------- /content/organizations/managing-organization-members/managing-organization-permissions.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Managing organization permissions 3 | redirect_from: 4 | - /managing-org-permissions 5 | --- 6 | 7 | import shared from '~/shared.js' 8 | 9 | As an organization owner, you can change the role of any member of your organization to add or remove permissions on the organization for that member. 10 | 11 | 1. <>{shared['user-login'].text} 12 | 13 | <>{shared['user-login'].image} 14 | 15 | 2. <>{shared['account-settings'].text} 16 | 17 | <>{shared['account-settings'].image} 18 | 19 | 3. <>{shared['organization-selection'].text} 20 | 21 | <>{shared['organization-selection'].image} 22 | 23 | 4. <>{shared['organization-members-tab'].text} 24 | 25 | <>{shared['organization-members-tab'].image} 26 | 27 | 5. In the list of organization members, find the member whose role you want to change. 28 | 29 | 6. In the member row, to select the new role of the organization member, click **member**, **admin**, or **owner**. 30 | 31 | 32 | -------------------------------------------------------------------------------- /content/organizations/managing-organization-members/removing-members-from-your-organization.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Removing members from your organization 3 | redirect_from: 4 | - /removing-members-from-your-org 5 | --- 6 | 7 | import shared from '~/shared.js' 8 | 9 | As an organization owner, you can remove members from your organization if they are no longer collaborating on packages owned or governed by your organization. 10 | 11 | If you remove a member from an npm Teams subscription (a paid organization), then they will lose access to your organization's private packages, and the credit card on file for your organization will not be charged for them on the next billing cycle. 12 | 13 | 14 | 15 | **Note:** Members are not notified when you remove them from your organization. 16 | 17 | 18 | 19 | 1. <>{shared['user-login'].text} 20 | 21 | <>{shared['user-login'].image} 22 | 23 | 2. <>{shared['account-settings'].text} 24 | 25 | <>{shared['account-settings'].image} 26 | 27 | 3. <>{shared['organization-selection'].text} 28 | 29 | <>{shared['organization-selection'].image} 30 | 31 | 4. <>{shared['organization-members-tab'].text} 32 | 33 | <>{shared['organization-members-tab'].image} 34 | 35 | 5. In the list of organization members, find the member you want to remove. 36 | 37 | 6. At the end of the member row, click **X**. 38 | 39 | 40 | -------------------------------------------------------------------------------- /content/organizations/managing-organization-packages/about-organization-scopes-and-packages.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: About organization scopes and packages 3 | redirect_from: 4 | - /about-org-scopes-and-packages 5 | --- 6 | 7 | Every organization is granted an organization scope, a unique namespace for packages owned by the organization that matches the organization name. For example, an organization named "wombat" would have the scope `@wombat`. 8 | 9 | You can use scopes to: 10 | 11 | - Maintain a fork of a package: `@wombat/request`. 12 | - Avoid name disputes with popular names: `@wombat/web`. 13 | - Easily find packages in the same namespace 14 | 15 | Packages in a scope must follow the same [naming guidelines][name-guidelines] as unscoped packages. 16 | 17 | ## Managing unscoped packages 18 | 19 | While you are granted a scope by default when you create an organization, you can also use organizations to manage unscoped packages, or packages under a different scope (such as a user scope). 20 | 21 | [name-guidelines]: /files/package.json#name 22 | -------------------------------------------------------------------------------- /content/organizations/managing-organization-packages/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Managing organization packages 3 | redirect_from: 4 | - /orgs/managing-org-packages 5 | edit_on_github: false 6 | --- 7 | 8 | 9 | -------------------------------------------------------------------------------- /content/organizations/managing-teams/creating-teams.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Creating teams 3 | --- 4 | 5 | import shared from '~/shared.js' 6 | 7 | As an organization owner or team admin, you can create teams to manage access to sets of packages governed by your organization. 8 | 9 | 10 | 11 | **Note:** Team names cannot be changed. To "rename" a team, you must delete the team and recreate it. 12 | 13 | 14 | 15 | 1. <>{shared['user-login'].text} 16 | 17 | <>{shared['user-login'].image} 18 | 19 | 2. <>{shared['account-settings'].text} 20 | 21 | <>{shared['account-settings'].image} 22 | 23 | 3. <>{shared['organization-selection'].text} 24 | 25 | <>{shared['organization-selection'].image} 26 | 27 | 4. <>{shared['organization-teams-tab'].text} 28 | 29 | <>{shared['organization-teams-tab'].image} 30 | 31 | 5. In the "Name" and "Description" fields, type a team name and helpful description. Team names must be lower case and cannot contain spaces or punctuation. 32 | 33 | 34 | 35 | 6. Click **Create Team**. 36 | 37 | 38 | 39 | 40 | 41 | **Note:** New teams do not have members or package access by default. Once you create a team, add packages and members from the "Teams" tab. 42 | 43 | 44 | -------------------------------------------------------------------------------- /content/organizations/managing-teams/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Managing teams 3 | redirect_from: 4 | - /orgs/managing-teams 5 | edit_on_github: false 6 | --- 7 | 8 | 9 | -------------------------------------------------------------------------------- /content/organizations/managing-teams/removing-organization-members-from-teams.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Removing organization members from teams 3 | redirect_from: 4 | - /removing-org-members-from-teams 5 | --- 6 | 7 | import shared from '~/shared.js' 8 | 9 | As an organization owner or team admin, you can remove organization members from teams if they no longer need access to packages accessible to the team. 10 | 11 | 1. <>{shared['user-login'].text} 12 | 13 | <>{shared['user-login'].image} 14 | 15 | 2. <>{shared['account-settings'].text} 16 | 17 | <>{shared['account-settings'].image} 18 | 19 | 3. <>{shared['organization-selection'].text} 20 | 21 | <>{shared['organization-selection'].image} 22 | 23 | 4. <>{shared['organization-teams-tab'].text} 24 | 25 | <>{shared['organization-teams-tab'].image} 26 | 27 | 5. In the list of team members, find the member you want to remove. 28 | 29 | 6. In the member row, to remove the member from the team, click **X**. 30 | 31 | 32 | 33 | 34 | 35 | **Note: Removing a member from a team, even if it is the only team they are a member of, will not remove them from the organization.** To remove a member from the organization, see "[Removing members from your organization][removing-organization-members]". 36 | 37 | 38 | 39 | [removing-organization-members]: removing-members-from-your-organization 40 | -------------------------------------------------------------------------------- /content/organizations/managing-teams/removing-teams.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Removing teams 3 | --- 4 | 5 | import shared from '~/shared.js' 6 | 7 | As an organization owner or team admin, you can remove teams that no longer need access to a set of packages governed by your organization. Removing the team will not remove the team members or packages from your organization. 8 | 9 | 10 | <>Note: if you remove all teams referencing a particular package, it will be orphaned and you will lose access to it. If this happens, {shared['contact-support'].text}. 11 | 12 | 13 | 1. <>{shared['user-login'].text} 14 | 15 | <>{shared['user-login'].image} 16 | 17 | 2. <>{shared['account-settings'].text} 18 | 19 | <>{shared['account-settings'].image} 20 | 21 | 3. <>{shared['organization-selection'].text} 22 | 23 | <>{shared['organization-selection'].image} 24 | 25 | 4. <>{shared['organization-teams-tab'].text} 26 | 27 | <>{shared['organization-teams-tab'].image} 28 | 29 | 5. Beside the name of the team you want to remove, click **X**. 30 | 31 | 32 | 33 | 34 | 35 | **Note:** You cannot remove the developers team, [learn more about the developers team](/about-developers-team). 36 | 37 | 38 | -------------------------------------------------------------------------------- /content/organizations/paying-for-your-organization/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Paying for your organization 3 | redirect_from: 4 | - /orgs/paying-for-your-org 5 | edit_on_github: false 6 | --- 7 | 8 | 9 | -------------------------------------------------------------------------------- /content/packages-and-modules/contributing-packages-to-the-registry/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Contributing packages to the registry 3 | redirect_from: 4 | - /getting-started/publishing-npm-packages 5 | edit_on_github: false 6 | --- 7 | 8 | 9 | -------------------------------------------------------------------------------- /content/packages-and-modules/contributing-packages-to-the-registry/package-name-guidelines.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Package name guidelines 3 | --- 4 | 5 | When choosing a name for your package, choose a name that: 6 | 7 | - Is unique 8 | - Is descriptive 9 | - Meets [npm policy guidelines][policies]. For example, do not give your package an offensive name, and do not use someone else's trademarked name or violate the [npm trademark policy][npm-trademark]. 10 | - Does _not_ contain uppercase letters 11 | 12 | Additionally, when choosing a name for an [**unscoped** package][create-unscoped], choose a name that: 13 | 14 | - Is not spelled in a similar way to another package name 15 | - Will not confuse others about authorship 16 | 17 | [policies]: https://www.npmjs.com/policies 18 | [npm-trademark]: https://docs.npmjs.com/policies/disputes#trademarks 19 | [create-unscoped]: creating-and-publishing-unscoped-public-packages 20 | -------------------------------------------------------------------------------- /content/packages-and-modules/getting-packages-from-the-registry/downloading-and-installing-packages-globally.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Downloading and installing packages globally 3 | redirect_from: 4 | - /getting-started/installing-npm-packages-globally 5 | --- 6 | 7 | 8 | 9 | **Tip:** If you are using npm 5.2 or higher, we recommend using `npx` to run packages globally. 10 | 11 | 12 | 13 | [Installing][cli-install] a package globally allows you to use the code in the package as a set of tools on your local computer. 14 | 15 | To download and install packages globally, on the command line, run the following command: 16 | 17 | ``` 18 | npm install -g 19 | ``` 20 | 21 | If you get an EACCES permissions error, you may need to reinstall npm with a version manager or manually change npm's default directory. For more information, see "[Resolving EACCES permissions errors when installing packages globally][perm-errors]". 22 | 23 | [cli-install]: /cli/install 24 | [perm-errors]: resolving-eacces-permissions-errors-when-installing-packages-globally 25 | -------------------------------------------------------------------------------- /content/packages-and-modules/getting-packages-from-the-registry/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Getting packages from the registry 3 | edit_on_github: false 4 | --- 5 | 6 | 7 | -------------------------------------------------------------------------------- /content/packages-and-modules/getting-packages-from-the-registry/using-deprecated-packages.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Using deprecated packages 3 | --- 4 | 5 | If you install a package, and it prints a deprecation message, we recommend following the instructions, if possible. 6 | 7 | That might mean updating to a new version, or updating your package dependencies. 8 | 9 | 10 | 11 | A deprecation message doesn't always mean the package or version is unusable; it may mean the package is unmaintained and will no longer be updated by the publisher. 12 | -------------------------------------------------------------------------------- /content/packages-and-modules/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Packages and modules 3 | edit_on_github: false 4 | --- 5 | 6 | 7 | -------------------------------------------------------------------------------- /content/packages-and-modules/introduction-to-packages-and-modules/about-public-packages.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: About public packages 3 | --- 4 | 5 | As an npm user or organization member, you can create and publish public packages that anyone can download and use in their own projects. 6 | 7 | - **Unscoped** public packages exist in the global public registry namespace and can be referenced in a `package.json` file with the package name alone: `package-name`. 8 | - **Scoped** public packages belong to a user or organization and must be preceded by the user or organization name when included as a dependency in a `package.json` file: 9 | - `@username/package-name` 10 | - `@org-name/package-name` 11 | 12 | ## Next steps 13 | 14 | - "[Creating and publishing scoped public packages][create-scoped-pkg]" 15 | - "[Creating and publishing unscoped public packages][create-unscoped-pkg]" 16 | - "[Using npm packages in your projects][use-pkg]" 17 | 18 | [create-scoped-pkg]: creating-and-publishing-scoped-public-packages 19 | [create-unscoped-pkg]: creating-and-publishing-unscoped-public-packages 20 | [use-pkg]: using-npm-packages-in-your-projects 21 | -------------------------------------------------------------------------------- /content/packages-and-modules/introduction-to-packages-and-modules/about-the-public-npm-registry.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: About the public npm registry 3 | --- 4 | 5 | The public npm registry is a database of JavaScript packages, each comprised of software and metadata. Open source developers and developers at companies use the npm registry to contribute packages to the entire community or members of their organizations, and download packages to use in their own projects. 6 | 7 | To get started with the registry, [sign up for an npm account][signup] and check out the "[Getting started][getting-started]" and [CLI][cli] documentation. 8 | 9 | [public-website]: https://npmjs.com 10 | [cli]: /cli-documentation 11 | [signup]: https://www.npmjs.com/signup 12 | [getting-started]: /getting-started 13 | -------------------------------------------------------------------------------- /content/packages-and-modules/introduction-to-packages-and-modules/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Introduction to packages and modules 3 | edit_on_github: false 4 | --- 5 | 6 | 7 | -------------------------------------------------------------------------------- /content/packages-and-modules/introduction-to-packages-and-modules/package-scope-access-level-and-visibility.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm package scope, access level, and visibility 3 | --- 4 | 5 | Visibility of npm packages depends on the scope (namespace) in which the package is contained, and the access level (private or public) set for the package. 6 | 7 | 8 | 9 | **Note:** To create organization-scoped packages, you must first create an organization. For more information, see "[Creating an organization](https://docs.npmjs.com/creating-an-organization)". 10 | 11 | 12 | 13 | ## npm Package Access Matrix 14 | 15 | | Scope | Access level | Can view and download | Can write (publish) | 16 | | --- | --- | --- | --- | 17 | | Org | Private | Members of a team in the organization with read access to the package | Members of a team in the organization with read and write access to the package | 18 | | Org | Public | Everyone | Members of a team in the organization with read and write access to the package | 19 | | User | Private | The package owner and users who have been granted read access to the package | The package owner and users who have been granted read and write access to the package | 20 | | User | Public | Everyone | The package owner and users who have been granted read and write access to the package | 21 | | Unscoped | Public | Everyone | The package owner and users who have been granted read and write access to the package | 22 | 23 | 24 | 25 | **Note:** Only user accounts can create and manage unscoped packages. Organizations can only manage scoped packages. 26 | 27 | 28 | -------------------------------------------------------------------------------- /content/packages-and-modules/securing-your-code/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Securing your code 3 | edit_on_github: false 4 | --- 5 | 6 | 7 | -------------------------------------------------------------------------------- /content/packages-and-modules/securing-your-code/verifying-registry-signatures.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Verifying ECDSA registry signatures 3 | --- 4 | 5 | To ensure the integrity of packages you download from the public npm registry, or any registry that supports signatures, you can verify the registry signatures of downloaded packages using the npm CLI. 6 | 7 | ## Prerequisites 8 | 9 | 1. Install npm CLI version v8.15.0 or later 10 | 2. Install dependencies using `npm install` or `npm ci` 11 | 12 | ## Verifying registry signatures 13 | 14 | Registry signatures can be verified using the following `audit` command: 15 | 16 | ``` 17 | npm audit signatures 18 | ``` 19 | 20 | Example response if all installed versions have valid registry signatures: 21 | 22 | ``` 23 | audited 1640 packages in 2s 24 | 25 | 1640 have verified registry signatures 26 | ``` 27 | 28 | ## Troubleshooting 29 | 30 | ### Some packages are missing registry signatures 31 | 32 | The CLI will error if packages don't have signatures _and_ if the package registry supports signatures. This could mean an attacker might be trying to circumvent signature verification. You can check if the registry supports signatures by requesting the public signing keys from `registry-host.tld/-/npm/v1/keys`. 33 | 34 | Example response if some versions have missing registry signatures: 35 | 36 | ``` 37 | audited 1640 packages in 2s 38 | 39 | 1405 packages have verified registry signatures 40 | 41 | 235 packages have missing registry signatures but the registry is providing signing keys: 42 | 43 | missing-dep@1.0.0 (https://registry.npmjs.org/) 44 | ... 45 | ``` 46 | -------------------------------------------------------------------------------- /content/packages-and-modules/updating-and-managing-your-published-packages/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Updating and managing your published packages 3 | edit_on_github: false 4 | --- 5 | 6 | 7 | -------------------------------------------------------------------------------- /content/packages-and-modules/updating-and-managing-your-published-packages/updating-your-published-package-version-number.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Updating your published package version number 3 | --- 4 | 5 | When you make significant changes to a published package, we recommend updating the version number to communicate the extent of the changes to others who rely on your code. 6 | 7 | 8 | 9 | **Note:** If you have linked a git repository to a package, updating the package version number will also add a tag with the updated release number to the linked git repository. 10 | 11 | 12 | 13 | 1. To change the version number in `package.json`, on the command line, in the package root directory, run the following command, replacing `` with one of the [semantic versioning][semver] release types (patch, major, or minor): 14 | 15 | ``` 16 | npm version 17 | ``` 18 | 19 | 2. Run `npm publish`. 20 | 21 | 3. Go to your package page (`https://npmjs.com/package/`) to check that the package version has been updated. 22 | 23 | For more information on `npm version`, see the [CLI documentation][cli-version]. 24 | 25 | [semver]: about-semantic-versioning 26 | [cli-version]: /cli/version 27 | -------------------------------------------------------------------------------- /content/policies/crawlers.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Crawler policy 3 | edit_on_github: false 4 | --- 5 | 6 | npm's full public dataset is available via the [public registry](https://docs.npmjs.com/misc/registry). Using CouchDB replication, you can get a full copy of all metadata, and it is acceptable within our terms of use to download copies of tarballs for inspection or experimentation. 7 | 8 | npm's [website](https://www.npmjs.com) also has package metadata available. We allow this content to be indexed by commercial crawlers such as GoogleBot. At our discretion, we also allow experimental crawlers to access the site, as long as they keep their request velocity to 1 request per second or less. At that velocity, indexing all packages would take 3 days, so if you want a full copy of our metadata it is always going to be faster to access the data via replication, which takes only an hour or two to provide full data and will thereafter automatically stay in sync. 9 | 10 | If you do not wish to install CouchDB to manage replication, we provide [open source software](https://github.com/npm/concurrent-couch-follower) that makes it easy to sync to the registry's public feed. 11 | 12 | If you attempt to access package metadata by high-velocity crawling of the npm website, we reserve the right to rate-limit or ban your IP, user-agent or both. 13 | -------------------------------------------------------------------------------- /content/policies/dmca.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Copyright - DMCA Takedown Policy 3 | edit_on_github: false 4 | --- 5 | 6 | This policy describes how we at npm, Inc., the company behind npmjs.com and the npm public registry, respond to claims that materials users have submitted to our service infringe copyright. 7 | 8 | npm follows GitHub's [Copyright - DMCA Takedown Policy](https://docs.github.com/site-policy/content-removal-policies/dmca-takedown-policy). Please carefully review that policy along with GitHub's [Guide to Submitting a DMCA Takedown Notice](https://docs.github.com/en/site-policy/content-removal-policies/guide-to-submitting-a-dmca-takedown-notice) to determine if you should submit a DMCA takedown. 9 | 10 | If you are ready to submit a DMCA takedown notice, the fastest way to get a response is to enter your information and answer all the questions on GitHub's [Copyright claims form](https://github.com/contact/dmca). Be sure to select the option indicating that your claim involves content on npm.js. 11 | 12 | You can also send an email notification to copyright@github.com. You may include an attachment if you like, but please also include a plain-text version of your letter in the body of your message. 13 | 14 | If you must send your notice by physical mail, you can do that too, but it will take substantially longer for us to receive and respond to it. Notices we receive via plain-text email have a much faster turnaround than PDF attachments or physical mail. If you still wish to mail us your notice, GitHub's physical address is: 15 | 16 | GitHub, Inc 17 | Attn: DMCA Agent 18 | 88 Colin P Kelly Jr St 19 | San Francisco, CA. 94107 20 | -------------------------------------------------------------------------------- /content/policies/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Policies 3 | edit_on_github: false 4 | --- 5 | 6 | These are the legal policies of npm, Inc. 7 | 8 | 9 | 10 | These are updated from time to time. Their sources are stored in a git repository at [https://github.com/npm/documentation/tree/main/content/policies](https://github.com/npm/documentation/tree/main/content/policies). 11 | -------------------------------------------------------------------------------- /content/policies/orgs-plan.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: npm Orgs Payment Plan 3 | edit_on_github: false 4 | --- 5 | 6 | This npm Orgs Payment Plan (this _Payment Plan_) supplements the terms for npm Open Source offered by npm, Inc. (_npm_) at [https://docs.npmjs.com/policies/open-source-terms][open-source-terms] (_npm Open Source Terms_), as well as the terms for npm Paid Services (_npm Paid Services_) at [https://docs.npmjs.com/policies/private-terms][private-terms] (_npm Paid Services Terms_). This Payment Plan governs payment for _Orgs_ and use of npm Paid Services by user accounts added as members of those Orgs. 7 | 8 | This Payment Plan was last updated on August 6, 2018. You can review prior versions at [https://github.com/npm/documentation/blob/main/content/policies/orgs-plan.mdx](https://github.com/npm/documentation/blob/main/content/policies/orgs-plan.mdx). 9 | 10 | Under this Payment Plan, you may create one or more Orgs. 11 | 12 | You will pay a minimum of $7.00 via your Payment Card when you create an Org, and thereafter on the same day every month (your _Billing Day_), until you delete the Org. This minimum payment entitles you to a single member of the Org (a _New Paid Services User_). You will pay $7.00 via your Payment Card per each additional New Paid Services User that you add to an Org, counted and billed on your Billing Day. 13 | 14 | Note that the npm Paid Services Terms require everyone using npm Paid Services to have an Account of their own, added under a Payment Plan. You must add a New Paid Services User to an Org for each person who will use npm Paid Services under this Payment Plan. 15 | 16 | [open-source-terms]: /policies/open-source-terms 17 | [private-terms]: /policies/private-terms 18 | -------------------------------------------------------------------------------- /content/policies/solo-plan.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Solo Payment Plan 3 | edit_on_github: false 4 | --- 5 | 6 | This npm Solo Payment Plan (this _Payment Plan_) supplements the terms for npm Open Source offered by npm, Inc. (_npm_) at [https://docs.npmjs.com/policies/open-source-terms][open-source-terms] (_npm Open Source Terms_), as well as the terms for npm Paid Services (_npm Paid Services_) at [https://docs.npmjs.com/policies/private-terms][private-terms](_npm Paid Services Terms_). This Payment Plan governs payment for use of npm Solo by a single user account. 7 | 8 | This Payment Plan was last updated on August 6, 2018. You can review prior versions at [https://github.com/npm/documentation/blob/main/content/policies/solo-plan.mdx](https://github.com/npm/documentation/blob/main/content/policies/solo-plan.mdx). 9 | 10 | You will pay $7.00 via your Payment Card when you enable npm Solo for your Account by selecting this Payment Plan, and thereafter on the same day every month while this Payment Plan remains selected for your Account. 11 | 12 | Note that the npm Paid Services Terms require everyone using npm Paid Services to have an Account of their own, added under a Payment Plan. You may not allow anyone else to use npm Paid Services under this Payment Plan. 13 | 14 | [open-source-terms]: /policies/open-source-terms 15 | [private-terms]: /policies/private-terms 16 | -------------------------------------------------------------------------------- /gatsby-browser.js: -------------------------------------------------------------------------------- 1 | import {SKIP_TO_SEARCH_ID} from './src/constants' 2 | 3 | export {default as wrapPageElement} from './src/page' 4 | export {default as wrapRootElement} from './src/root' 5 | 6 | export const shouldUpdateScroll = ({routerProps}) => { 7 | const {scrollUpdate = true} = routerProps.location.state ?? {} 8 | return scrollUpdate 9 | } 10 | 11 | export const onRouteUpdate = ({location, prevLocation}) => { 12 | if (location.hash === `#${SKIP_TO_SEARCH_ID}` && prevLocation?.hash !== `#${SKIP_TO_SEARCH_ID}`) { 13 | document.getElementById(SKIP_TO_SEARCH_ID)?.focus() 14 | } 15 | } 16 | -------------------------------------------------------------------------------- /gatsby-ssr.js: -------------------------------------------------------------------------------- 1 | export {default as wrapPageElement} from './src/page' 2 | export {default as wrapRootElement} from './src/root' 3 | -------------------------------------------------------------------------------- /jest-preprocess.js: -------------------------------------------------------------------------------- 1 | const babelOptions = { 2 | presets: ['babel-preset-gatsby'], 3 | } 4 | 5 | module.exports = require('babel-jest').default.createTransformer(babelOptions) 6 | -------------------------------------------------------------------------------- /jest-setup.js: -------------------------------------------------------------------------------- 1 | import '@testing-library/jest-dom/jest-globals' 2 | global.CSS = {supports: () => false} 3 | -------------------------------------------------------------------------------- /jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | testEnvironment: 'jsdom', 3 | setupFilesAfterEnv: ['/jest-setup.js'], 4 | transform: { 5 | '^.+\\.jsx?$': `/jest-preprocess.js`, 6 | }, 7 | moduleNameMapper: { 8 | '.+\\.(css|styl|less|sass|scss)$': `identity-obj-proxy`, 9 | }, 10 | } 11 | -------------------------------------------------------------------------------- /scripts/template-oss/_step-deps-yml.hbs: -------------------------------------------------------------------------------- 1 | - name: Install Dependencies 2 | run: {{ rootNpmPath }} i --no-audit --no-fund {{~#if jobDepFlags}} {{ jobDepFlags }}{{/if}} 3 | -------------------------------------------------------------------------------- /scripts/template-oss/_step-lint-yml.hbs: -------------------------------------------------------------------------------- 1 | {{> defaultStepLintYml }} 2 | - name: Check Format 3 | run: {{ rootNpmPath }} run format:check --ignore-scripts --if-present {{~#if jobRunFlags}} {{ jobRunFlags }}{{/if}} 4 | -------------------------------------------------------------------------------- /scripts/template-oss/ci-yml.hbs: -------------------------------------------------------------------------------- 1 | {{> ciYml }} 2 | 3 | test-cli-content: 4 | {{> jobMatrixYml jobName="Test CLI Content" }} 5 | - name: Check CLI Documentation 6 | run: npm run build -w cli -- --check-only 7 | env: 8 | GITHUB_TOKEN: $\{{ secrets.GITHUB_TOKEN }} 9 | 10 | licenses: 11 | name: REUSE Compliance Check 12 | runs-on: ubuntu-latest 13 | steps: 14 | - uses: actions/checkout@v4 15 | - name: REUSE Compliance Check 16 | uses: fsfe/reuse-action@v1 17 | -------------------------------------------------------------------------------- /scripts/template-oss/dependabot-yml.hbs: -------------------------------------------------------------------------------- 1 | {{> defaultDependabotYml }} 2 | groups: 3 | dependency-updates: 4 | applies-to: version-updates 5 | patterns: 6 | - "*" 7 | update-types: 8 | - "minor" 9 | - "patch" 10 | -------------------------------------------------------------------------------- /scripts/template-oss/package-json.hbs: -------------------------------------------------------------------------------- 1 | { 2 | "scripts": { 3 | "lint": "eslint \"**/*.{js,mjs,mdx}\"", 4 | "test": "jest", 5 | "snap": {{{ del }}}, 6 | "format": "prettier --write ." 7 | }, 8 | "files": {{{ del }}}, 9 | "tap": {{{ del }}} 10 | } 11 | -------------------------------------------------------------------------------- /src/components/breadcrumbs.js: -------------------------------------------------------------------------------- 1 | import React from 'react' 2 | import {Breadcrumbs as PrimerBreadcrumbs} from '@primer/react' 3 | import {Link as GatsbyLink} from 'gatsby' 4 | import * as getNav from '../util/get-nav' 5 | import usePage from '../hooks/use-page' 6 | 7 | const BreadcrumbItem = ({item, path}) => { 8 | const selected = getNav.isPathForItem(path, getNav.getItem(item.url)) 9 | 10 | return ( 11 | 12 | {item.shortName || item.title} 13 | 14 | ) 15 | } 16 | 17 | const Breadcrumbs = () => { 18 | const {pathname} = usePage().location 19 | const items = getNav.getItemBreadcrumbs(pathname, {hideVariants: true}) 20 | 21 | if (items.length <= 1) { 22 | return null 23 | } 24 | 25 | return ( 26 | 27 | {items.map(item => ( 28 | 29 | ))} 30 | 31 | ) 32 | } 33 | 34 | export default Breadcrumbs 35 | -------------------------------------------------------------------------------- /src/components/link.js: -------------------------------------------------------------------------------- 1 | import React from 'react' 2 | import {Link as PrimerLink} from '@primer/react' 3 | import {Link as GatsbyLink} from 'gatsby' 4 | import omit from '../util/omit' 5 | 6 | const FALLBACK = `http://_${Math.random().toString().slice(2)}._${Math.random().toString().slice(2)}` 7 | 8 | const getLocalPath = href => { 9 | if (!href || href.startsWith('#')) { 10 | return null 11 | } 12 | 13 | try { 14 | const url = new URL(href, FALLBACK) 15 | if (url.host === 'docs.npmjs.com' || url.origin === FALLBACK) { 16 | return `${url.pathname}${url.search}${url.hash}` 17 | } 18 | } catch { 19 | // ignore errors which will just pass along all props to PrimerLink 20 | } 21 | 22 | return null 23 | } 24 | 25 | const GatsbyLinkWithoutSxProps = React.forwardRef(function GatsbyLinkWithoutSxProps(props, ref) { 26 | return 27 | }) 28 | 29 | const Link = React.forwardRef(function Link({to, href, ...props}, ref) { 30 | const localPath = getLocalPath(href) 31 | 32 | if (to || localPath !== null) { 33 | return 34 | } 35 | 36 | return 37 | }) 38 | 39 | export const LinkNoUnderline = React.forwardRef(function LinkNoUnderline({sx, ...props}, ref) { 40 | return ( 41 | 51 | ) 52 | }) 53 | 54 | export default Link 55 | -------------------------------------------------------------------------------- /src/components/sidebar.js: -------------------------------------------------------------------------------- 1 | import {Box} from '@primer/react' 2 | import React from 'react' 3 | import NavItems from './nav-items' 4 | import {FULL_HEADER_HEIGHT} from '../constants' 5 | 6 | function usePersistentScroll(id) { 7 | const ref = React.useRef() 8 | 9 | const handleScroll = React.useCallback( 10 | // Save scroll position in session storage on every scroll change 11 | event => window.sessionStorage.setItem(id, event.target.scrollTop), 12 | [id], 13 | ) 14 | 15 | React.useLayoutEffect(() => { 16 | // Restore scroll position when component mounts 17 | const scrollPosition = window.sessionStorage.getItem(id) 18 | if (scrollPosition && ref.current) { 19 | ref.current.scrollTop = scrollPosition 20 | } 21 | }, [id]) 22 | 23 | // Return props to spread onto the scroll container 24 | return { 25 | ref, 26 | onScroll: handleScroll, 27 | } 28 | } 29 | 30 | const Sidebar = () => ( 31 | 40 | 51 | 52 | 53 | 54 | 55 | 56 | ) 57 | 58 | export default Sidebar 59 | -------------------------------------------------------------------------------- /src/components/site-title.js: -------------------------------------------------------------------------------- 1 | import React from 'react' 2 | import {Box} from '@primer/react' 3 | import Link from './link' 4 | import useSiteMetadata from '../hooks/use-site-metadata' 5 | 6 | const NpmLogo = ({size, sx}) => ( 7 | 8 | 12 | 13 | ) 14 | 15 | const SiteTitle = ({logo, sx}) => { 16 | const siteMetadata = useSiteMetadata() 17 | 18 | return ( 19 | 30 | {logo ? : null} 31 | {siteMetadata.title} 32 | 33 | ) 34 | } 35 | 36 | export default SiteTitle 37 | -------------------------------------------------------------------------------- /src/components/skip-nav.js: -------------------------------------------------------------------------------- 1 | import React from 'react' 2 | import {Box, themeGet} from '@primer/react' 3 | import styled from 'styled-components' 4 | import Link from './link' 5 | import {SCROLL_MARGIN_TOP, SKIP_TO_CONTENT_ID} from '../constants' 6 | 7 | export const SkipLink = styled(Link)` 8 | color: ${themeGet('colors.accent.emphasis')}; 9 | padding: ${themeGet('space.1')}; 10 | &:focus { 11 | text-decoration: underline; 12 | } 13 | ` 14 | 15 | // The following rules are to ensure that the element is visually hidden, unless 16 | // it has focus. This is the recommended way to hide content from: 17 | // https://webaim.org/techniques/css/invisiblecontent/#techniques 18 | export const SkipBox = styled.div` 19 | display: inline-flex; 20 | z-index: 20; 21 | left: 10px; 22 | gap: 3px; 23 | position: absolute; 24 | transform: translateY(-100%); 25 | transition: transform 0.3s; 26 | padding: ${themeGet('space.2')}; 27 | background-color: ${themeGet('colors.canvas.default')}; 28 | border: 1px solid ${themeGet('colors.accent.emphasis')}; 29 | border-top: 0; 30 | font-size: ${themeGet('fontSizes.1')}; 31 | border-radius: 0 0 ${themeGet('radii.2')} ${themeGet('radii.2')}; 32 | 33 | 34 | &:focus-within { 35 | transform: translateY(0%); 36 | } 37 | 38 | & > * { 39 | margin-right: ${themeGet('space.1')}; 40 | } 41 | 42 | & > *:last-child { 43 | margin-right: 0; 44 | } 45 | ` 46 | 47 | const SkipNavBase = props => 48 | 49 | export const SkipNav = styled(SkipNavBase)` 50 | scroll-margin-top: ${SCROLL_MARGIN_TOP}px; 51 | ` 52 | -------------------------------------------------------------------------------- /src/components/text-input.js: -------------------------------------------------------------------------------- 1 | import {TextInput as PrimerTextInput, themeGet} from '@primer/react' 2 | import styled from 'styled-components' 3 | 4 | const TextInput = styled(PrimerTextInput)` 5 | /* The font-size of inputs should never be less than 16px. 6 | * Otherwise, iOS browsers will zoom in when the input is focused. 7 | * TODO: Update font-size of TextInput in @primer/react. 8 | */ 9 | input { 10 | font-size: ${themeGet('fontSizes.2')} !important; 11 | color: ${themeGet('colors.fg.default')} !important; 12 | } 13 | 14 | input::placeholder { 15 | color: ${themeGet('colors.fg.default')} !important; 16 | } 17 | ` 18 | export default TextInput 19 | -------------------------------------------------------------------------------- /src/components/visually-hidden.js: -------------------------------------------------------------------------------- 1 | import styled from 'styled-components' 2 | 3 | /** Visually hide an element, but keep it accessible to screen readers. */ 4 | const VisuallyHidden = styled.div` 5 | position: absolute; 6 | width: 1px; 7 | height: 1px; 8 | padding: 0; 9 | margin: -1px; 10 | overflow: hidden; 11 | clip: rect(0, 0, 0, 0); 12 | white-space: nowrap; 13 | border-width: 0; 14 | ` 15 | 16 | export default VisuallyHidden 17 | -------------------------------------------------------------------------------- /src/constants.js: -------------------------------------------------------------------------------- 1 | export const HEADER_HEIGHT = 56 2 | 3 | export const HEADER_BAR = 10 4 | 5 | export const FULL_HEADER_HEIGHT = HEADER_HEIGHT + HEADER_BAR 6 | 7 | export const SCROLL_MARGIN_TOP = FULL_HEADER_HEIGHT + 24 8 | 9 | export const SKIP_TO_CONTENT_ID = 'skip-to-content' 10 | 11 | export const SKIP_TO_SEARCH_ID = 'search-box-input' 12 | 13 | export const CLI_PATH = '/cli' 14 | -------------------------------------------------------------------------------- /src/favicon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/src/favicon.png -------------------------------------------------------------------------------- /src/head.js: -------------------------------------------------------------------------------- 1 | import React from 'react' 2 | import useSiteMetdata from './hooks/use-site-metadata' 3 | 4 | const buildTitle = (...parts) => [...new Set(parts.filter(Boolean))].join(' | ') 5 | 6 | export const Head = ({pageContext: {frontmatter = {}}}) => { 7 | const siteMetadata = useSiteMetdata() 8 | 9 | const title = buildTitle(frontmatter.title, siteMetadata.title) 10 | const description = frontmatter.description || siteMetadata.description 11 | 12 | return ( 13 | <> 14 | {title} 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | ) 23 | } 24 | 25 | const PassThrough = ({children}) => children 26 | 27 | export default PassThrough 28 | -------------------------------------------------------------------------------- /src/hooks/use-breakpoint.js: -------------------------------------------------------------------------------- 1 | import React from 'react' 2 | import {useTheme} from '@primer/react' 3 | 4 | const getMatches = query => (typeof window !== 'undefined' ? window.matchMedia(query).matches : false) 5 | 6 | // The MIT License (MIT) 7 | // Copyright (c) 2020 Julien CARON 8 | // https://github.com/juliencrn/usehooks-ts/blob/master/packages/usehooks-ts/src/useMediaQuery/useMediaQuery.ts 9 | export function useMediaQuery(query) { 10 | const [matches, setMatches] = React.useState(getMatches(query)) 11 | const handleChange = React.useCallback(() => setMatches(getMatches(query)), [query]) 12 | 13 | React.useEffect(() => { 14 | handleChange() 15 | const matchMedia = window.matchMedia(query) 16 | matchMedia.addEventListener('change', handleChange) 17 | return () => matchMedia.removeEventListener('change', handleChange) 18 | }, [query, handleChange]) 19 | 20 | return matches 21 | } 22 | 23 | export function useBreakpoint(breakpoint, minMax = 'min') { 24 | // Handle string values from themes with units at the end 25 | const px = typeof breakpoint === 'string' ? parseInt(breakpoint, 10) : breakpoint 26 | return useMediaQuery(`(${minMax}-width: ${px - (minMax === 'min' ? 0 : 1)}px)`) 27 | } 28 | 29 | // a common breakpoint where things change on mobile 30 | export function useIsMobile() { 31 | const {theme} = useTheme() 32 | return useBreakpoint(theme.breakpoints[2], 'max') 33 | } 34 | 35 | export default useBreakpoint 36 | -------------------------------------------------------------------------------- /src/hooks/use-location-change.js: -------------------------------------------------------------------------------- 1 | import React from 'react' 2 | import usePage from './use-page' 3 | 4 | const useLocationChange = () => { 5 | const {pathname} = usePage().location 6 | const pathRef = React.useRef(null) 7 | const [pathChange, setPathChange] = React.useState({change: false}) 8 | 9 | React.useEffect(() => { 10 | if (pathRef.current && pathRef.current !== pathname) { 11 | setPathChange({change: true, current: pathname, previous: pathRef.current}) 12 | } 13 | pathRef.current = pathname 14 | }, [pathname]) 15 | 16 | return pathChange 17 | } 18 | 19 | export default useLocationChange 20 | -------------------------------------------------------------------------------- /src/hooks/use-page.js: -------------------------------------------------------------------------------- 1 | import React from 'react' 2 | 3 | const Page = React.createContext(null) 4 | export const PageProvider = Page.Provider 5 | const usePage = () => React.useContext(Page) 6 | export default usePage 7 | -------------------------------------------------------------------------------- /src/hooks/use-site-metadata.js: -------------------------------------------------------------------------------- 1 | import {useStaticQuery, graphql} from 'gatsby' 2 | 3 | function useSiteMetadata() { 4 | const data = useStaticQuery(graphql` 5 | { 6 | site { 7 | siteMetadata { 8 | title 9 | shortName 10 | description 11 | lang 12 | imageUrl 13 | repositoryUrl 14 | } 15 | } 16 | } 17 | `) 18 | return data.site.siteMetadata 19 | } 20 | 21 | export default useSiteMetadata 22 | -------------------------------------------------------------------------------- /src/mdx/index.js: -------------------------------------------------------------------------------- 1 | import * as Components from './components' 2 | 3 | export const a = Components.Link 4 | export const pre = ({children}) => children 5 | export const code = Components.Code 6 | export const table = Components.Table 7 | export const img = Components.Image 8 | export const p = Components.Paragraph 9 | export const hr = Components.HorizontalRule 10 | export const blockquote = Components.Blockquote 11 | export const h1 = Components.H1 12 | export const h2 = Components.H2 13 | export const h3 = Components.H3 14 | export const h4 = Components.H4 15 | export const h5 = Components.H5 16 | export const h6 = Components.H6 17 | export const ul = Components.UnorderedList 18 | export const ol = Components.OrderedList 19 | export const dl = Components.DescriptionList 20 | export const Index = Components.Index 21 | export const Note = Components.Note 22 | export const Prompt = Components.Prompt 23 | export const Screenshot = Components.Screenshot 24 | export const Link = Components.Link 25 | export const YouTube = Components.YouTube 26 | -------------------------------------------------------------------------------- /src/mdx/nav-hierarchy.js: -------------------------------------------------------------------------------- 1 | import React from 'react' 2 | import {Box} from '@primer/react' 3 | import Link from '../components/link' 4 | import * as getNav from '../util/get-nav' 5 | import usePage from '../hooks/use-page' 6 | 7 | const HierarchyItem = ({item, maxDepth, depth, hideVariants}) => { 8 | const hierarchy = getNav.getHierarchy(item, null, {hideVariants}) 9 | 10 | return ( 11 | 12 | 13 | {item.title} 14 | 15 | {item.description ? {item.description} : null} 16 | {hierarchy ? ( 17 | 18 | ) : null} 19 | 20 | ) 21 | } 22 | 23 | const Hierarchy = ({items, maxDepth, depth, hideVariants}) => { 24 | if (maxDepth && depth > maxDepth) { 25 | return null 26 | } 27 | 28 | return ( 29 | 30 | {items.map(item => ( 31 | 32 | ))} 33 | 34 | ) 35 | } 36 | 37 | function NavHierarchy({depth, hideVariants}) { 38 | const {pathname} = usePage().location 39 | const hierarchy = getNav.getHierarchy(getNav.getItem(pathname), null, {hideVariants}) 40 | 41 | return 42 | } 43 | 44 | export default NavHierarchy 45 | -------------------------------------------------------------------------------- /src/root.js: -------------------------------------------------------------------------------- 1 | import React from 'react' 2 | import {MDXProvider} from '@mdx-js/react' 3 | import {ThemeProvider} from './theme' 4 | import * as components from './mdx' 5 | 6 | const RootElement = ({element}) => ( 7 | 8 | {element} 9 | 10 | ) 11 | 12 | export default RootElement 13 | -------------------------------------------------------------------------------- /src/theme.js: -------------------------------------------------------------------------------- 1 | import React from 'react' 2 | import {ThemeProvider as Provider, theme, Box} from '@primer/react' 3 | import deepmerge from 'deepmerge' 4 | 5 | export const NPM_RED = '#cb3837' 6 | 7 | export const npmTheme = deepmerge(theme, { 8 | colors: { 9 | logoBg: NPM_RED, 10 | }, 11 | colorSchemes: { 12 | light: { 13 | colors: { 14 | accent: { 15 | fg: NPM_RED, 16 | emphasis: NPM_RED, 17 | }, 18 | }, 19 | }, 20 | dark_dimmed: { 21 | colors: { 22 | canvas: { 23 | default: '#333333', 24 | }, 25 | fg: { 26 | default: '#E1E4E8', 27 | }, 28 | btn: { 29 | text: '#E1E4E8', 30 | bg: 'transparent', 31 | border: '#444D56', 32 | hoverBorder: '#444D56', 33 | hoverBg: NPM_RED, 34 | }, 35 | }, 36 | }, 37 | }, 38 | }) 39 | 40 | export const ThemeProvider = props => 41 | 42 | export const Theme = React.forwardRef(function Theme({theme: colorMode, as = Box, ...props}, ref) { 43 | return ( 44 | 45 | {React.createElement(as, {...props, ref})} 46 | 47 | ) 48 | }) 49 | 50 | export const LightTheme = React.forwardRef(function LightTheme(props, ref) { 51 | return 52 | }) 53 | 54 | export const DarkTheme = React.forwardRef(function DarkTheme(props, ref) { 55 | return 56 | }) 57 | -------------------------------------------------------------------------------- /src/util/omit.js: -------------------------------------------------------------------------------- 1 | const omit = (obj, ...keys) => { 2 | const res = {} 3 | for (const k of Object.keys(obj)) { 4 | if (!keys.includes(k)) { 5 | res[k] = obj[k] 6 | } 7 | } 8 | return res 9 | } 10 | 11 | export default omit 12 | -------------------------------------------------------------------------------- /static/enterprise/setup-and-configuration/acknowledge-blocking.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/enterprise/setup-and-configuration/acknowledge-blocking.png -------------------------------------------------------------------------------- /static/enterprise/setup-and-configuration/sso-configure.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/enterprise/setup-and-configuration/sso-configure.png -------------------------------------------------------------------------------- /static/enterprise/setup-and-configuration/sso-save.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/enterprise/setup-and-configuration/sso-save.png -------------------------------------------------------------------------------- /static/enterprise/setup-and-configuration/sso-settings-form.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/enterprise/setup-and-configuration/sso-settings-form.png -------------------------------------------------------------------------------- /static/enterprise/user-management/activate-user.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/enterprise/user-management/activate-user.png -------------------------------------------------------------------------------- /static/enterprise/user-management/deactivate-user.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/enterprise/user-management/deactivate-user.png -------------------------------------------------------------------------------- /static/enterprise/user-management/manage-users.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/enterprise/user-management/manage-users.png -------------------------------------------------------------------------------- /static/getting-started/managing-your-npm-user-account/account-deletion-confirmation.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/managing-your-npm-user-account/account-deletion-confirmation.png -------------------------------------------------------------------------------- /static/getting-started/managing-your-npm-user-account/connect-github.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/managing-your-npm-user-account/connect-github.png -------------------------------------------------------------------------------- /static/getting-started/managing-your-npm-user-account/connect-twitter.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/managing-your-npm-user-account/connect-twitter.png -------------------------------------------------------------------------------- /static/getting-started/managing-your-npm-user-account/delete-your-account.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/managing-your-npm-user-account/delete-your-account.png -------------------------------------------------------------------------------- /static/getting-started/managing-your-npm-user-account/github-authorize.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/managing-your-npm-user-account/github-authorize.png -------------------------------------------------------------------------------- /static/getting-started/managing-your-npm-user-account/github-disconnect.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/managing-your-npm-user-account/github-disconnect.png -------------------------------------------------------------------------------- /static/getting-started/managing-your-npm-user-account/github-login.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/managing-your-npm-user-account/github-login.png -------------------------------------------------------------------------------- /static/getting-started/managing-your-npm-user-account/github-remove.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/managing-your-npm-user-account/github-remove.png -------------------------------------------------------------------------------- /static/getting-started/managing-your-npm-user-account/github-success.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/managing-your-npm-user-account/github-success.png -------------------------------------------------------------------------------- /static/getting-started/managing-your-npm-user-account/profile-settings-cli.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/managing-your-npm-user-account/profile-settings-cli.png -------------------------------------------------------------------------------- /static/getting-started/managing-your-npm-user-account/requesting-your-data.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/managing-your-npm-user-account/requesting-your-data.png -------------------------------------------------------------------------------- /static/getting-started/managing-your-npm-user-account/twitter-authorize.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/managing-your-npm-user-account/twitter-authorize.png -------------------------------------------------------------------------------- /static/getting-started/managing-your-npm-user-account/twitter-disconnect.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/managing-your-npm-user-account/twitter-disconnect.png -------------------------------------------------------------------------------- /static/getting-started/managing-your-npm-user-account/twitter-login.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/managing-your-npm-user-account/twitter-login.png -------------------------------------------------------------------------------- /static/getting-started/managing-your-npm-user-account/twitter-remove.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/managing-your-npm-user-account/twitter-remove.png -------------------------------------------------------------------------------- /static/getting-started/managing-your-npm-user-account/twitter-success.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/managing-your-npm-user-account/twitter-success.png -------------------------------------------------------------------------------- /static/getting-started/paying-for-your-npm-user-account/billing-upgrade-button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/paying-for-your-npm-user-account/billing-upgrade-button.png -------------------------------------------------------------------------------- /static/getting-started/paying-for-your-npm-user-account/billing-upgrade-form.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/paying-for-your-npm-user-account/billing-upgrade-form.png -------------------------------------------------------------------------------- /static/getting-started/paying-for-your-npm-user-account/change-plan.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/paying-for-your-npm-user-account/change-plan.png -------------------------------------------------------------------------------- /static/getting-started/paying-for-your-npm-user-account/enable-private-publishing.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/paying-for-your-npm-user-account/enable-private-publishing.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/2fa-add-security-key.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/2fa-add-security-key.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/2fa-auth-pub-select.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/2fa-auth-pub-select.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/2fa-disable-submit.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/2fa-disable-submit.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/2fa-disable.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/2fa-disable.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/2fa-enable.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/2fa-enable.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/2fa-modify.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/2fa-modify.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/2fa-use-security-key.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/2fa-use-security-key.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/2fa-verify.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/2fa-verify.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/cli-login-screen.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/cli-login-screen.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/create-account-button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/create-account-button.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/device-selection.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/device-selection.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/disable-2fa-button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/disable-2fa-button.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/email-otp-code.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/email-otp-code.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/go-back-to-settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/go-back-to-settings.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/link-github-account.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/link-github-account.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/link-twitter-account.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/link-twitter-account.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/lost-recovery-code.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/lost-recovery-code.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/one-time-password-email.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/one-time-password-email.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/open-support-ticket.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/open-support-ticket.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/privacy-policy.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/privacy-policy.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/recover-account.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/recover-account.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/recovery-code-link.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/recovery-code-link.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/recovery-code.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/recovery-code.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/request-account-recovery.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/request-account-recovery.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/signin-screen.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/signin-screen.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/signup-form.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/signup-form.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/touch-id-mac-edge.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/touch-id-mac-edge.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/user-a-recovery-code.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/user-a-recovery-code.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/view-recovery-codes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/view-recovery-codes.png -------------------------------------------------------------------------------- /static/getting-started/setting-up-your-npm-user-account/webauthn-cli-login-token.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/getting-started/setting-up-your-npm-user-account/webauthn-cli-login-token.png -------------------------------------------------------------------------------- /static/integrations/integrating-npm-with-external-services/create-token.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/integrations/integrating-npm-with-external-services/create-token.png -------------------------------------------------------------------------------- /static/integrations/integrating-npm-with-external-services/granular-access-token-ip-range.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/integrations/integrating-npm-with-external-services/granular-access-token-ip-range.png -------------------------------------------------------------------------------- /static/integrations/integrating-npm-with-external-services/granular-access-token-organizations.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/integrations/integrating-npm-with-external-services/granular-access-token-organizations.png -------------------------------------------------------------------------------- /static/integrations/integrating-npm-with-external-services/granular-access-token-packages-scopes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/integrations/integrating-npm-with-external-services/granular-access-token-packages-scopes.png -------------------------------------------------------------------------------- /static/integrations/integrating-npm-with-external-services/granular-access-token-summary.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/integrations/integrating-npm-with-external-services/granular-access-token-summary.png -------------------------------------------------------------------------------- /static/integrations/integrating-npm-with-external-services/token-level-select.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/integrations/integrating-npm-with-external-services/token-level-select.png -------------------------------------------------------------------------------- /static/integrations/integrating-npm-with-external-services/tokens-profile.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/integrations/integrating-npm-with-external-services/tokens-profile.png -------------------------------------------------------------------------------- /static/organizations/creating-and-managing-organizations/convert-confirmation.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/creating-and-managing-organizations/convert-confirmation.png -------------------------------------------------------------------------------- /static/organizations/creating-and-managing-organizations/convert-from-user.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/creating-and-managing-organizations/convert-from-user.png -------------------------------------------------------------------------------- /static/organizations/creating-and-managing-organizations/convert-new-username.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/creating-and-managing-organizations/convert-new-username.png -------------------------------------------------------------------------------- /static/organizations/creating-and-managing-organizations/create-confirm.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/creating-and-managing-organizations/create-confirm.png -------------------------------------------------------------------------------- /static/organizations/creating-and-managing-organizations/create-invite.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/creating-and-managing-organizations/create-invite.png -------------------------------------------------------------------------------- /static/organizations/creating-and-managing-organizations/create-name.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/creating-and-managing-organizations/create-name.png -------------------------------------------------------------------------------- /static/organizations/creating-and-managing-organizations/left-sidebar.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/creating-and-managing-organizations/left-sidebar.png -------------------------------------------------------------------------------- /static/organizations/creating-and-managing-organizations/org-delete-button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/creating-and-managing-organizations/org-delete-button.png -------------------------------------------------------------------------------- /static/organizations/creating-and-managing-organizations/org-delete-plan.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/creating-and-managing-organizations/org-delete-plan.png -------------------------------------------------------------------------------- /static/organizations/managing-organization-members/accept-invitation.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/managing-organization-members/accept-invitation.png -------------------------------------------------------------------------------- /static/organizations/managing-organization-members/change-member-role.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/managing-organization-members/change-member-role.png -------------------------------------------------------------------------------- /static/organizations/managing-organization-members/invite-button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/managing-organization-members/invite-button.png -------------------------------------------------------------------------------- /static/organizations/managing-organization-members/invite-members-button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/managing-organization-members/invite-members-button.png -------------------------------------------------------------------------------- /static/organizations/managing-organization-members/remove-member.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/managing-organization-members/remove-member.png -------------------------------------------------------------------------------- /static/organizations/managing-organization-members/revoke-invitation.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/managing-organization-members/revoke-invitation.png -------------------------------------------------------------------------------- /static/organizations/managing-organization-members/username-or-email-field.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/managing-organization-members/username-or-email-field.png -------------------------------------------------------------------------------- /static/organizations/managing-teams/team-creation-confirmation.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/managing-teams/team-creation-confirmation.png -------------------------------------------------------------------------------- /static/organizations/managing-teams/team-member-add-button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/managing-teams/team-member-add-button.png -------------------------------------------------------------------------------- /static/organizations/managing-teams/team-member-remove-button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/managing-teams/team-member-remove-button.png -------------------------------------------------------------------------------- /static/organizations/managing-teams/team-member-select.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/managing-teams/team-member-select.png -------------------------------------------------------------------------------- /static/organizations/managing-teams/team-members.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/managing-teams/team-members.png -------------------------------------------------------------------------------- /static/organizations/managing-teams/team-name-description.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/managing-teams/team-name-description.png -------------------------------------------------------------------------------- /static/organizations/managing-teams/team-package-add-existing-button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/managing-teams/team-package-add-existing-button.png -------------------------------------------------------------------------------- /static/organizations/managing-teams/team-package-change-permissions.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/managing-teams/team-package-change-permissions.png -------------------------------------------------------------------------------- /static/organizations/managing-teams/team-package-permissions.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/managing-teams/team-package-permissions.png -------------------------------------------------------------------------------- /static/organizations/managing-teams/team-package-remove-button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/managing-teams/team-package-remove-button.png -------------------------------------------------------------------------------- /static/organizations/managing-teams/team-package-select.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/managing-teams/team-package-select.png -------------------------------------------------------------------------------- /static/organizations/managing-teams/team-packages-button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/managing-teams/team-packages-button.png -------------------------------------------------------------------------------- /static/organizations/managing-teams/team-remove.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/managing-teams/team-remove.png -------------------------------------------------------------------------------- /static/organizations/requiring-two-factor-authentication-in-your-organization/enable-2fa.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/requiring-two-factor-authentication-in-your-organization/enable-2fa.png -------------------------------------------------------------------------------- /static/organizations/requiring-two-factor-authentication-in-your-organization/removal-confirmation.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/organizations/requiring-two-factor-authentication-in-your-organization/removal-confirmation.png -------------------------------------------------------------------------------- /static/packages-and-modules/deleting-deprecating/delete-package-confirm.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/packages-and-modules/deleting-deprecating/delete-package-confirm.png -------------------------------------------------------------------------------- /static/packages-and-modules/deleting-deprecating/delete-package-settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/packages-and-modules/deleting-deprecating/delete-package-settings.png -------------------------------------------------------------------------------- /static/packages-and-modules/deleting-deprecating/deprecate-package-confirm.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/packages-and-modules/deleting-deprecating/deprecate-package-confirm.png -------------------------------------------------------------------------------- /static/packages-and-modules/deleting-deprecating/deprecate-package-settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/packages-and-modules/deleting-deprecating/deprecate-package-settings.png -------------------------------------------------------------------------------- /static/packages-and-modules/getting-packages-from-the-registry/npm-provenance-check-mark.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/packages-and-modules/getting-packages-from-the-registry/npm-provenance-check-mark.png -------------------------------------------------------------------------------- /static/packages-and-modules/getting-packages-from-the-registry/npm-provenance-unreachable-source-commit@2x.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/packages-and-modules/getting-packages-from-the-registry/npm-provenance-unreachable-source-commit@2x.png -------------------------------------------------------------------------------- /static/packages-and-modules/getting-packages-from-the-registry/npm-provenance.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/packages-and-modules/getting-packages-from-the-registry/npm-provenance.png -------------------------------------------------------------------------------- /static/packages-and-modules/getting-packages-from-the-registry/package-deprecated.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/packages-and-modules/getting-packages-from-the-registry/package-deprecated.png -------------------------------------------------------------------------------- /static/packages-and-modules/getting-packages-from-the-registry/search-results.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/packages-and-modules/getting-packages-from-the-registry/search-results.png -------------------------------------------------------------------------------- /static/packages-and-modules/getting-packages-from-the-registry/search-sort-options.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/packages-and-modules/getting-packages-from-the-registry/search-sort-options.png -------------------------------------------------------------------------------- /static/packages-and-modules/getting-packages-from-the-registry/search-suggestions.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/packages-and-modules/getting-packages-from-the-registry/search-suggestions.png -------------------------------------------------------------------------------- /static/packages-and-modules/securing-your-code/2fa-package-admin.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/packages-and-modules/securing-your-code/2fa-package-admin.png -------------------------------------------------------------------------------- /static/packages-and-modules/securing-your-code/2fa-package-disable.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/packages-and-modules/securing-your-code/2fa-package-disable.png -------------------------------------------------------------------------------- /static/packages-and-modules/securing-your-code/2fa-package-require.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/packages-and-modules/securing-your-code/2fa-package-require.png -------------------------------------------------------------------------------- /static/packages-and-modules/securing-your-code/2fa-package-setting.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/packages-and-modules/securing-your-code/2fa-package-setting.png -------------------------------------------------------------------------------- /static/packages-and-modules/securing-your-code/2fa-package-turnoff.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/packages-and-modules/securing-your-code/2fa-package-turnoff.png -------------------------------------------------------------------------------- /static/packages-and-modules/securing-your-code/2fa-package-update.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/packages-and-modules/securing-your-code/2fa-package-update.png -------------------------------------------------------------------------------- /static/packages-and-modules/securing-your-code/audit-manual-review.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/packages-and-modules/securing-your-code/audit-manual-review.png -------------------------------------------------------------------------------- /static/packages-and-modules/securing-your-code/audit-no-vulnerabilities.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/packages-and-modules/securing-your-code/audit-no-vulnerabilities.png -------------------------------------------------------------------------------- /static/packages-and-modules/securing-your-code/audit-report-results.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/packages-and-modules/securing-your-code/audit-report-results.png -------------------------------------------------------------------------------- /static/packages-and-modules/securing-your-code/audit-report-suggested-fixes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/packages-and-modules/securing-your-code/audit-report-suggested-fixes.png -------------------------------------------------------------------------------- /static/packages-and-modules/updating-and-managing-your-published-packages/deprecate-package.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/packages-and-modules/updating-and-managing-your-published-packages/deprecate-package.png -------------------------------------------------------------------------------- /static/packages-and-modules/updating-and-managing-your-published-packages/deprecate-version.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/packages-and-modules/updating-and-managing-your-published-packages/deprecate-version.png -------------------------------------------------------------------------------- /static/packages-and-modules/updating-and-managing-your-published-packages/package-maintainer-invite.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/packages-and-modules/updating-and-managing-your-published-packages/package-maintainer-invite.png -------------------------------------------------------------------------------- /static/packages-and-modules/updating-and-managing-your-published-packages/package-maintainer-list.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/packages-and-modules/updating-and-managing-your-published-packages/package-maintainer-list.png -------------------------------------------------------------------------------- /static/shared/account-settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/account-settings.png -------------------------------------------------------------------------------- /static/shared/billing-creditcard-form.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/billing-creditcard-form.png -------------------------------------------------------------------------------- /static/shared/billing-downgrade-confirm.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/billing-downgrade-confirm.png -------------------------------------------------------------------------------- /static/shared/billing-downgrade-selection.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/billing-downgrade-selection.png -------------------------------------------------------------------------------- /static/shared/billing-download-checked.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/billing-download-checked.png -------------------------------------------------------------------------------- /static/shared/billing-download-icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/billing-download-icon.png -------------------------------------------------------------------------------- /static/shared/billing-email-checked.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/billing-email-checked.png -------------------------------------------------------------------------------- /static/shared/billing-email-icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/billing-email-icon.png -------------------------------------------------------------------------------- /static/shared/billing-email-receipt.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/billing-email-receipt.png -------------------------------------------------------------------------------- /static/shared/billing-extra-info.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/billing-extra-info.png -------------------------------------------------------------------------------- /static/shared/billing-extra-receipt-email.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/billing-extra-receipt-email.png -------------------------------------------------------------------------------- /static/shared/billing-extra-save.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/billing-extra-save.png -------------------------------------------------------------------------------- /static/shared/billing-form.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/billing-form.png -------------------------------------------------------------------------------- /static/shared/billing-history.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/billing-history.png -------------------------------------------------------------------------------- /static/shared/billing-info.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/billing-info.png -------------------------------------------------------------------------------- /static/shared/billing-plan-selection.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/billing-plan-selection.png -------------------------------------------------------------------------------- /static/shared/billing-receipt-settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/billing-receipt-settings.png -------------------------------------------------------------------------------- /static/shared/billing-update-card.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/billing-update-card.png -------------------------------------------------------------------------------- /static/shared/billing-view-icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/billing-view-icon.png -------------------------------------------------------------------------------- /static/shared/enterprise-activate-user.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/enterprise-activate-user.png -------------------------------------------------------------------------------- /static/shared/enterprise-admin-panel-settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/enterprise-admin-panel-settings.png -------------------------------------------------------------------------------- /static/shared/enterprise-admin-panel.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/enterprise-admin-panel.png -------------------------------------------------------------------------------- /static/shared/enterprise-admin-profile-menu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/enterprise-admin-profile-menu.png -------------------------------------------------------------------------------- /static/shared/enterprise-choose-security-policy.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/enterprise-choose-security-policy.png -------------------------------------------------------------------------------- /static/shared/enterprise-custom-blocking-message.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/enterprise-custom-blocking-message.png -------------------------------------------------------------------------------- /static/shared/enterprise-deactivate-user-button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/enterprise-deactivate-user-button.png -------------------------------------------------------------------------------- /static/shared/enterprise-manage-users-button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/enterprise-manage-users-button.png -------------------------------------------------------------------------------- /static/shared/enterprise-sso-configure.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/enterprise-sso-configure.png -------------------------------------------------------------------------------- /static/shared/enterprise-sso-save-button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/enterprise-sso-save-button.png -------------------------------------------------------------------------------- /static/shared/enterprise-sso-settings-form.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/enterprise-sso-settings-form.png -------------------------------------------------------------------------------- /static/shared/organization-billing-tab.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/organization-billing-tab.png -------------------------------------------------------------------------------- /static/shared/organization-create.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/organization-create.png -------------------------------------------------------------------------------- /static/shared/organization-members-tab.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/organization-members-tab.png -------------------------------------------------------------------------------- /static/shared/organization-package-private.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/organization-package-private.png -------------------------------------------------------------------------------- /static/shared/organization-package-public.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/organization-package-public.png -------------------------------------------------------------------------------- /static/shared/organization-selection.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/organization-selection.png -------------------------------------------------------------------------------- /static/shared/organization-teams-tab.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/organization-teams-tab.png -------------------------------------------------------------------------------- /static/shared/payment-info-button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/payment-info-button.png -------------------------------------------------------------------------------- /static/shared/payment-info.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/payment-info.png -------------------------------------------------------------------------------- /static/shared/payment-remember-me.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/payment-remember-me.png -------------------------------------------------------------------------------- /static/shared/profile-settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/profile-settings.png -------------------------------------------------------------------------------- /static/shared/user-login.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/npm/documentation/28ef95f5b3e44086001e84583a69f7be84c52cd2/static/shared/user-login.png -------------------------------------------------------------------------------- /webpack.config.js: -------------------------------------------------------------------------------- 1 | const {resolve} = require('path') 2 | // XXX do not export a devServer from this file. 3 | // See https://github.com/advisories/GHSA-wr3j-pwj9-hqq6 for more info. 4 | module.exports = { 5 | resolve: { 6 | alias: { 7 | '~': resolve(__dirname, 'src'), 8 | }, 9 | extensions: ['.js'], 10 | }, 11 | } 12 | --------------------------------------------------------------------------------