Skip to content

yarn run

Terminal window
yarn run

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

OptionDescription
--top-levelIf set, the script or binary used will be the one in the top-level workspace
--error-if-missingIf set (the default), an error will be returned if the script or binary is not found
--run-cwdThe directory in which to run the script or binary
--inspectForwarded to the underlying Node process when executing a binary
--inspect-brkForwarded to the underlying Node process when executing a binary
--inspect-waitForwarded to the underlying Node process when executing a binary
--requireForwarded to the underlying Node process when executing a binary