Início·Comandos de terminal

npm run

Pacotes e runtimes

Uso

npm run <script> [-- <args>]

Executa um comando da seção scripts do package.json; argumentos para o script exigem um -- antes, e só start e test podem ser chamados sem run.

Opções comuns

OpçãoSignificado
--everything after it goes to the script, not to npm
--if-presentexit quietly when the script is missing
-w <workspace>run it in one workspace
--workspacesrun it in every workspace
-shide npm own output

Exemplos

npm run build

runs the build script from package.json

npm run test -- --watch

passes --watch to the test runner, not to npm

npm run

with no name, lists the scripts that exist

A pergunta é sempre o que vai onde: dentro deste projeto ou na máquina toda.

Como ler

  • Os colchetes [ ] marcam uma parte que você pode omitir.
  • As reticências … indicam que você pode listar vários.
  • As opções diferenciam maiúsculas: em alguns comandos -r e -R fazem coisas diferentes.

Perguntas

Q. O que npm run faz?

Executa um comando da seção scripts do package.json; argumentos para o script exigem um -- antes, e só start e test podem ser chamados sem run.

Q. Como se digita?

npm run <script> [-- <args>] — os colchetes marcam o que você pode omitir.

Q. Quantas opções vale a pena saber?

Aqui estão 5; a lista completa está em man npm. Este comando fica em Pacotes e runtimes.

Comandos relacionados

página man: man npm-run