Monorepo World: October 7, 2024Monorepo World: October 7, 2024Join us!
Run any custom commands with Nx.
Options can be configured in project.json when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/reference/project-configuration#targets.
project.json:
1{
2 // ...
3 "targets": {
4 //...
5 "ls-project-root": {
6 "executor": "nx:run-commands",
7 "options": {
8 "command": "ls apps/frontend/src"
9 }
10 }
11 }
12}
13❯
nx run frontend:ls-project-root
The commands option accepts as many commands as you want. By default, they all run in parallel. You can run them sequentially by setting parallel: false:
1"create-script": {
2 "executor": "nx:run-commands",
3 "options": {
4 "commands": [
5 "mkdir -p apps/frontend/scripts",
6 "touch apps/frontend/scripts/my-script.sh",
7 "chmod +x apps/frontend/scripts/my-script.sh"
8 ],
9 "parallel": false
10 }
11}
12This type has all of the properties below, but must also match this type:
oneOf [required: commands, required: command]Command to run in child process.
trueRun commands in parallel.
Extra arguments. You can pass them as follows: nx run project:target --args='--wait=100'. You can then use {args.wait} syntax to interpolate them in the workspace config file. See example above
falseUse colors when showing output of command.
Current working directory of the commands. If it's not specified the commands will run in the workspace root, if a relative path is specified the commands will run in that path relative to the workspace root and if it's an absolute path the commands will run in that path.
You may specify a custom .env file path.
Environment variables that will be made available to the commands. This property has priority over the .env files.
trueWhether arguments should be forwarded when interpolation is not present.
String or array of strings to appear in stdout or stderr that indicate that the task is done. When running multiple commands, this option can only be used when parallel is set to true. If not specified, the task is done when all the child processes complete.
Whether commands should be run with a tty terminal
Extra properties of any type may be provided to this object.
No description available.