omz-pnpm-plugin

oh-my-zsh pnpm plugin (omz-pnpm-plugin)

Installs the omz-plugin-pnpm oh-my-zsh plugin (pnpm aliases) from the itplusx tag mirror into the remote user's oh-my-zsh custom plugins and activates it. The plugin respects a pre-set PNPM_HOME and never leaves it empty.

Example Usage

"features": {
    "ghcr.io/itplusx/devcontainer-features/omz-pnpm-plugin:1": {}
}

Options

Options Id	Description	Type	Default Value
ref	Git tag or branch of https://github.com/itplusx/omz-plugin-pnpm to install.	string	v1.1.0
activate	Add 'pnpm' to the plugins=(...) line of the remote user's ~/.zshrc if it is not listed yet.	boolean	true

How it works

• install.sh clones the itplusx fork of omz-plugin-pnpm at the given ref into /usr/local/share/omz-pnpm-plugin/pnpm (system-wide, no .git). If the remote user already has oh-my-zsh at build time, it installs the plugin right away.
• oncreate.sh (onCreateCommand) copies the plugin into ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/pnpm and, with activate: true, appends pnpm to the plugins=(...) line of ~/.zshrc if missing. It is idempotent and also covers oh-my-zsh being installed by a feature that runs after this one. If oh-my-zsh is not present, it does nothing.

Why a fork

The original ntnyq/omz-plugin-pnpm used to mishandle PNPM_HOME:

• when pnpm -g bin failed (fresh container, bin dir not on PATH) it still ran export PNPM_HOME="", and pnpm treats an empty PNPM_HOME as the current directory. Every pnpm call then created global/ and package-manager-store/ in your project root.
• when pnpm -g bin succeeded it overrode PNPM_HOME with the bin dir. On pnpm 11+ that is $PNPM_HOME/bin, which moves the package-manager store out of the volume that shared-pnpm-store mounts.

Both are fixed upstream since September 2026 (the plugin no longer calls pnpm on shell start at all). Upstream publishes no tags, so the fork exists as a tag source: v1.0.0 is the original itplusx fix, v1.1.0 and later mirror upstream commits verbatim. Aliases are unchanged either way.

Pairing with shared-pnpm-store

Use both features together. shared-pnpm-store sets PNPM_HOME and the global bin dir at the image level, this feature makes sure the interactive zsh does not undo that.

"features": {
    "ghcr.io/nils-geistmann/devcontainers-features/zsh:0.0.8": {
        "plugins": "git docker"
    },
    "ghcr.io/itplusx/devcontainer-features/shared-pnpm-store:1.1.0": {},
    "ghcr.io/itplusx/devcontainer-features/omz-pnpm-plugin:1.0.1": {}
}

Listing pnpm in the zsh feature's plugins option is optional; with activate: true this feature adds it.

OS and Architecture Support

Architectures: amd and arm

OS: ubuntu, debian

Requires git at build time (installed via apt if missing) and oh-my-zsh for the remote user (from common-utils, nils-geistmann/zsh or any other source). Without oh-my-zsh the feature installs cleanly and does nothing.

Changelog

Version	Notes
1.0.1	Default ref is v1.1.0, a mirror of upstream after the PNPM_HOME fix landed there
1.0.0	Initial release

---

Note: This file was auto-generated from the devcontainer-feature.json. Add additional notes to a NOTES.md.