Pular para o conteúdo principal
Versão: Next

pnpm install

Aliases: i

pnpm install é usado para instalar todas as dependências de um projeto.

Num ambiente de CI, a instalação falhará se um lockfile estiver presente, mas precise ser atualizado.

Dentro de uma área de trabalho, pnpm install instala todas as dependências em todos os projetos. Se quiser desativar este comportamento, mude a configuração de recursive-install para false.

Resumo​

ComandoSignificado
pnpm i --offlineInstala offline apenas com os pacotes em cache
pnpm i --frozen-lockfileO pnpm-lock.yaml não é atualizado
pnpm i --lockfile-onlyApenas o pnpm-lock.yaml é atualizado

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​

  • Padrão: false
  • Tipo: 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 não serão instaladas.

Opções​

--force​

Força a reinstalação das dependências: busca novamente pacotes modificados na loja, recriando um lockfile e/ou modificando o diretório de módulos criados por uma versão não compatível do pnpm. Instala todas as dependências opcionais, mesmo que elas não satisfaçam o ambiente atual (cpu, os, arch).

--offline​

  • Padrão: false
  • Tipo: Boolean

Se true, pnpm irá usar apenas os pacotes disponíveis em cache. Se um pacote não for encontrado localmente, a instalação falhará.

--prefer-offline​

  • Padrão: false
  • Tipo: Boolean

Se true, as verificações de desatualização dos dados cacheados serão ignorados, mas os dados ausentes serão solicitados do servidor. Para forçar o modo offline, use --offline.

--no-lockfile​

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

--lockfile-only​

  • Padrão: false
  • Tipo: Boolean

Quando passado, apenas atualiza o pnpm-lock.yaml e package.json. Nada será escrito no diretório node_modules.

--fix-lockfile​

Corrige entradas quebradas no lockfile.

--frozen-lockfile​

  • Padrão:
    • Fora de CI: false
    • Em CI: true, se um lockfile estiver presente
  • Tipo: Boolean

Se true, o pnpm não vai gerar um lockfile e vai falhar a instalação nas seguintes situações: o lockfile não está em conforme com o manifesto, uma atualização é necessária ou não tem nenhum lockfile presente.

Essa configuração é por padrão true no ambiente de CI. O seguinte código é usado para detectar ambientes 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>​

  • Padrão:
    • Em stdout TTY: default
    • Em stdout não TTY: append-only
  • Tipo: default, append-only, ndjson, silent

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

  • silent - nenhuma informação será impressa no terminal, nem mesmo para erros fatais
  • default - o relator padrão quando o stdout é TTY
  • append-only - A saída é sempre adicionada no final. O cursor não é manipulado
  • ndjson - o relator mais detalhador. Prints all logs in ndjson format

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

--use-store-server​

  • Padrão: false
  • Tipo: Boolean
perigo

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​

  • Padrão: false
  • Tipo: Boolean

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

--ignore-scripts​

  • Padrão: low
  • Tipo: Boolean

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

--filter <package_selector>​

Leia mais sobre filtragem.

--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.