CLI reference
pnpr [OPTIONS]
pnpr [OPTIONS] oci-gc --registry <name>
Options
| Flag | Description |
|---|---|
-c, --config <path> | Path to a YAML config. When omitted, the global config.yaml in pnpr's config dir is used if it exists, otherwise the bundled default config. |
--listen <addr> | Address to bind to. Defaults to 127.0.0.1:7677. |
--storage <path> | Override the storage directory from the loaded config — the source of truth for hosted packages. |
--cache <path> | Override the disposable cache directory (the mirror of upstream registries, resolver cache, and local shared-artifact store). Defaults to a .pnpr-cache subdirectory of the storage path. |
--public-url <url> | URL clients should use to reach the server, used when rewriting dist.tarball URLs in served packuments. Defaults to http://<listen>. |
--packument-ttl-secs <n> | Seconds before a cached packument is considered stale and refetched. When omitted, the loaded config's value wins. |
--osv | Enable local OSV npm vulnerability checks. Requires a local OSV npm database zip at --osv-db or <cache>/osv/npm/all.zip. |
--osv-db <path> | Path to the local OSV npm database zip or extracted JSON directory. |
--disable-registry | Disable the npm registry surface (packument and tarball reads, publish, unpublish, dist-tags, and search) that is otherwise served whenever the config declares at least one registry. The health and login/token endpoints stay available. |
--disable-resolver | Disable the install-accelerator surface: GET /-/pnpr, POST /-/pnpr/v0/resolve, and POST /-/pnpr/v0/verify-lockfile. Overrides resolver.enabled. |
--disable-artifacts | Disable the signed shared-artifact surface. Overrides artifacts.enabled independently of the resolver. |
-h, --help | Print help. |
-V, --version | Print version. |
Every flag has an environment variable
Since v0.1.0-alpha.11, pnpr reads any option from an environment variable when
the flag is omitted. The variable is the flag's name with a PNPR_ prefix, so
--public-url becomes PNPR_PUBLIC_URL and --disable-resolver becomes
PNPR_DISABLE_RESOLVER. A flag given on the command line wins over its
variable. Boolean flags accept true, 1, yes, on, false, 0, no,
and off.
PNPR_LISTEN=0.0.0.0:7677 PNPR_PUBLIC_URL=https://registry.example.com pnpr
Subcommands
oci-gc
Added in: v0.1.0-alpha.11
Reclaims container image blobs that no retained manifest references. Every writer sharing the store must be stopped for the whole run.
| Flag | Description |
|---|---|
--registry <name> | The concrete hosted OCI registry to collect, by its config name. Required. |
--dry-run | Report the candidates without deleting anything. |
--min-age-secs <n> | Keep blobs younger than this. Defaults to 86400, so an interrupted push can still resume. 0 collects every unreferenced blob. |
Logging
The log level is controlled with the standard RUST_LOG environment variable,
which always wins over the level set in the config file:
RUST_LOG=debug pnpr
The config log.level accepts trace, debug, http, info, warn, and
error. http enables one access-log record per request while keeping the
rest of the crate quieter.
Examples
Bind to all interfaces and tell clients to reach the server through a public hostname:
pnpr --listen 0.0.0.0:7677 --public-url https://registry.example.com
Run with a custom config and a separate, ephemeral cache volume:
pnpr -c ./pnpr.yaml --cache /mnt/ephemeral/pnpr-cache
Run only the pnpr resolver endpoints, without exposing an npm registry surface:
pnpr --disable-registry