Passer au contenu principal
Version : 10.x

pnpm install

Aliases: i

pnpm install is used to install all dependencies for a project.

Dans un environnement CI, l'installation échoue si un fichier de verrouillage est présent mais nécessite une mise à jour.

Inside a workspace, pnpm install installs all dependencies in all the projects. If you want to disable this behavior, set the recursive-install setting to false.

TL;DR​

CommandMeaning
pnpm i --offlineInstaller hors ligne à partir du magasin uniquement
pnpm i --frozen-lockfilepnpm-lock.yaml is not updated
pnpm i --lockfile-onlyOnly pnpm-lock.yaml is updated

Options for filtering dependencies​

Without a lockfile, pnpm has to create one, and it must be consistent regardless of dependencies filtering, so running pnpm install --prod on a directory without a lockfile would still resolve the dev dependencies, and it would error if the resolution is unsuccessful. The only exception for this rule are link: dependencies.

Without --frozen-lockfile, pnpm will check for outdated information from file: dependencies, so running pnpm install --prod without --frozen-lockfile on an environment where the target of file: has been removed would error.

--prod, -P​

  • Default: false
  • Type: Boolean

If true, pnpm will not install any package listed in devDependencies and will remove those insofar they were already installed. If false, pnpm will install all packages listed in devDependencies and dependencies.

--dev, -D​

Only devDependencies are installed and dependencies are removed insofar they were already installed.

--no-optional​

optionalDependencies are not installed.

Options​

--force​

Force la réinstallation des dépendances : récupère les packages modifiés dans le "store", recrée un fichier "lockfile" et/ou un répertoire de modules créés par une version non compatible de pnpm. Install all optionalDependencies even they don't satisfy the current environment(cpu, os, arch).

--offline​

  • Default: false
  • Type: Boolean

If true, pnpm will use only packages already available in the store. Si un paquet ne se trouve pas localement, l'installation échouera.

--prefer-offline​

  • Default: false
  • Type: Boolean

If true, staleness checks for cached data will be bypassed, but missing data will be requested from the server. To force full offline mode, use --offline.

--no-lockfile​

Don't read or generate a pnpm-lock.yaml file.

--lockfile-only​

  • Default: false
  • Type: Boolean

When used, only updates pnpm-lock.yaml and package.json. Nothing gets written to the node_modules directory.

--fix-lockfile​

Correction automatique des entrées "lockfile" cassées.

--frozen-lockfile​

  • Par défaut:
    • For non-CI: false
    • For CI: true, if a lockfile is present
  • Type: Boolean

If true, pnpm doesn't generate a lockfile and fails to install if the lockfile is out of sync with the manifest / an update is needed or no lockfile is present.

This setting is true by default in CI environments. Le code suivant est utilisé pour détecter les environnements de CI :

https://github.com/watson/ci-info/blob/44e98cebcdf4403f162195fbcf90b1f69fc6e047/index.js#L54-L61
exports.isCI = !!(
  env.CI || // Travis CI, CircleCI, Cirrus CI, GitLab CI, Appveyor, CodeShip, dsari
  env.CONTINUOUS_INTEGRATION || // Travis CI, Cirrus CI
  env.BUILD_NUMBER || // Jenkins, TeamCity
  env.RUN_ID || // TaskCluster, dsari
  exports.name ||
  false
)

--merge-git-branch-lockfiles​

Merge all git branch lockfiles. Read more about git branch lockfiles.

--reporter=<name>​

  • Par défaut:
    • For TTY stdout: default
    • For non-TTY stdout: append-only
  • Type: default, append-only, ndjson, silent

Allows you to choose the reporter that will log debug info to the terminal about the installation progress.

  • silent - no output is logged to the console, not even fatal errors
  • default - the default reporter when the stdout is TTY
  • append-only - the output is always appended to the end. Aucune manipulation de curseur n'est effectuée
  • ndjson - the most verbose reporter. Prints all logs in ndjson format

If you want to change what type of information is printed, use the loglevel setting.

--use-store-server​

  • Default: false
  • Type: Boolean
danger

Deprecated feature

Starts a store server in the background. The store server will keep running after installation is done. To stop the store server, run pnpm server stop

--shamefully-hoist​

  • Default: false
  • Type: Boolean

Creates a flat node_modules structure, similar to that of npm or yarn. WARNING: This is highly discouraged.

--ignore-scripts​

  • Default: false
  • Type: Boolean

Do not execute any scripts defined in the project package.json and its dependencies.

--filter <package_selector>​

Read more about filtering.

--resolution-only​

Re-runs resolution: useful for printing out peer dependency issues.

--cpu=<name>​

Added in: v10.14.0

Override CPU architecture of native modules to install. Acceptable values are same as cpu field of package.json, which comes from process.arch.

--os=<name>​

Added in: v10.14.0

Override OS of native modules to install. Acceptable values are same as os field of package.json, which comes from process.platform.

--libc=<name>​

Added in: v10.14.0

Override libc of native modules to install. Acceptable values are same as libc field of package.json.