Skip to main content

yarn run

Run a script defined in the package.json.

Usage​

$ yarn run <scriptName> ...

Examples​

Run the tests from the local workspace :

yarn run test

Same thing, but without the "run" keyword :

yarn test

Inspect Webpack while running :

yarn run --inspect-brk webpack

Details​

This command will run a tool. The exact tool that will be executed will depend on the current state of your workspace:

  • If the scripts field from your local package.json contains a matching script name, its definition will get executed.

  • Otherwise, if one of the local workspace's dependencies exposes a binary with a matching name, this binary will get executed.

  • Otherwise, if the specified name contains a colon character and if one of the workspaces in the project contains exactly one script with a matching name, then this script will get executed.

Whatever happens, the cwd of the spawned process will be the workspace that declares the script (which makes it possible to call commands cross-workspaces using the third syntax).

Options​

DefinitionDescription

--inspect

Forwarded to the underlying Node process when executing a binary

--inspect-brk

Forwarded to the underlying Node process when executing a binary

-T,--top-level

Check the root workspace for scripts and/or binaries instead of the current one

-B,--binaries-only

Ignore any user defined scripts and only check for binaries

--require #0

Forwarded to the underlying Node process when executing a binary