nx/docs/shared/running-custom-commands.md
2021-02-05 20:33:28 -05:00

62 lines
1.2 KiB
Markdown

# Running Custom Commands
This recipe will show how to run any terminal command within the nx build-chain.
## Steps
##### 1. Define the terminal command to be run
The command we want to run for each project is:
```bash
make hello
```
With this `Makefile` in the root of the project:
```shell script
hello:
echo "Hello, world!"
```
##### 2. Update `workspace.json`
For each project for which you want to enable `make`, add a target in `workspace.json`:
```json
// ...
"my-app": {
"targets": {
"make": {
"executor": "@nrwl/workspace:run-commands",
"options": {
"commands": [
{
"command": "make hello"
}
]
}
}
// ...
}
}
```
For more information, see the [run-commands api doc](/{{framework}}/workspace/run-commands-executor).
##### 3. Trigger the executor from the terminal
To run the executor for a single project:
```bash
nx run my-app:make
```
To run the executor for all affected projects:
```bash
nx affected --target=make
```
For more information, see the [nx affected](/{{framework}}/cli/affected).