nx/docs/shared/running-custom-commands.md
Isaac Mann cb452b48a4
docs(core): use project.json instead of workspace.json (#8936)
Co-authored-by: Isaac Mann <isaacplmann+git@gmail.com>
2022-02-11 17:00:54 +00:00

1.1 KiB

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:

make hello

With this Makefile in the root of the project:

hello:
  echo "Hello, world!"
2. Update project.json

For each project for which you want to enable make, add a target in its project.json:

// ...
"targets": {
    "make": {
        "executor": "@nrwl/workspace:run-commands",
            "options": {
            "commands": [
                {
                    "command": "make hello"
                }
            ]
        }
    }
    // ...
}

For more information, see the run-commands api doc.

3. Trigger the executor from the terminal

To run the executor for a single project:

nx run my-app:make

To run the executor for all affected projects:

nx affected --target=make

For more information, see the nx affected.