pnpm config

Псевдоніми: с

Керування файлами конфігурації.

pnpm settings are split across two kinds of configuration files:

• Registry and authentication settings live in INI files — the global rc file and local .npmrc files.
• All other pnpm settings live in YAML files — the global config.yaml and the per-project pnpm-workspace.yaml.

The local workspace configuration file is located at the root of the project and is named pnpm-workspace.yaml. The global YAML configuration file (config.yaml) is located at:

• Якщо встановлено змінну $XDG_CONFIG_HOME env, то $XDG_CONFIG_HOME/pnpm/config.yaml
• У Windows: ~/AppData/Local/pnpm/config/config.yaml
• У macOS: ~/Library/Preferences/pnpm/config.yaml
• У Linux: ~/.config/pnpm/config.yaml

The global rc file (registry/auth settings only) is at:

• Якщо встановлено змінну середовища $XDG_CONFIG_HOME, тоді $XDG_CONFIG_HOME/pnpm/rc
• У Windows: ~/AppData/Local/pnpm/config/rc
• У macOS: ~/Library/Preferences/pnpm/rc
• У Linux: ~/.config/pnpm/rc

Ви також можете отримати шлях до вашого глобального конфігураційного файлу, виконавши команду (додано у версії 10.21.0):

pnpm config get globalconfig

Команди

set <key> <value>

Встановити значення для ключа конфігурації.

Без прапорця --json значення розбирається як звичайний рядок:

pnpm config set --location=project nodeVersion 22.0.0

З прапорцем --json він розбирається значення як JSON:

pnpm config set --location=project --json nodeVersion '"22.0.0"'

Прапорець --json також дозволяє pnpm config set створювати масиви та обʼєкти:

pnpm config set --location=project --json allowBuilds '{"react": true, "react-dom": true}'
pnpm config set --location=project --json catalog '{ "react": "19" }'

Команда set не приймає шлях до властивості.

get <key>

Вивести значення конфігурації для вказаного ключа.

Ключ key може бути простим ключем:

pnpm config get nodeVersion
pnpm config get --json nodeVersion
pnpm config get --json packageExtensions
pnpm config get --json allowBuilds
pnpm config get --json catalog

Він також може бути шляхом до властивості:

pnpm config get 'packageExtensions["@babel/parser"].peerDependencies["@babel/types"]'
pnpm config get --json 'packageExtensions["@babel/parser"].peerDependencies["@babel/types"]'
pnpm config get 'allowBuilds.react'
pnpm config get --json 'allowBuilds.react'
pnpm config get catalog.react
pnpm config get --json catalog.react

Синтаксис шляху до властивості імітує шляхи до властивостей JavaScript.

delete <key>

Видалити ключ конфігурації з файлу конфігурації.

list

Показати всі параметри конфігурації. Output is a JSON object.

Auth-related settings are hidden from the output; use pnpm config get <key> to read them explicitly.

нотатка

Since v11, pnpm config get (without --json) no longer prints INI-formatted text. It prints JSON for objects and arrays, and raw strings for strings, numbers, booleans, and nulls. pnpm config get --json prints all values as JSON. pnpm config list always prints a JSON object.

Параметри

--global, -g

Встановити конфігурацію у файлі глобальної конфігурації.

--location

Стандартно для --location встановлено значення global.

When set to project, pnpm writes the setting to pnpm-workspace.yaml at the workspace root (or, for registry/auth settings, to the .npmrc in the workspace root).

When set to global, the behavior is the same as passing the --global option.

--json

Зробити так, щоб get і list показували всі налаштування конфігурації у форматі JSON, а set аналізував значення як JSON.