Web UI

Added in: v0.1.0-alpha.15

pnpr serves a web UI at /-/ui/ for browsing its registries and packages. The UI is the separate @pnpm/pnpr-ui package. Install it next to pnpr:

pnpm add -g @pnpm/pnpr,@pnpm/pnpr-ui

The comma puts both packages in one global install group, where pnpr can find the UI. With npm, run npm install -g @pnpm/pnpr @pnpm/pnpr-ui.

Start pnpr and open http://127.0.0.1:7677/-/ui/. The UI talks to the server that serves it, so it needs no CORS setting. To see private packages, sign in with a password or with an OIDC provider that offers browser sign-in. The UI keeps the session token in the tab's session storage, so it survives a reload and ends when the tab closes.

pnpr serves the UI only when the registry surface is enabled. The UI loads its font from Google Fonts.

Settings#

ui:
  enabled: true
  dir: ./pnpr-ui

• enabled: false serves no UI, even when @pnpm/pnpr-ui is installed. Defaults to true.
• dir: the directory of a built UI, such as the dist directory of @pnpm/pnpr-ui. A relative path is resolved against the directory of the config file. pnpr does not start when the directory has no index.html. Without dir, pnpr serves @pnpm/pnpr-ui when it is installed next to pnpr.

The container image does not include the UI. To serve it from a container, mount the dist directory of @pnpm/pnpr-ui and set dir.