Skip to content

Commit b4c7cfe

Browse files
chore(readme): update to include other exe methode (#216)
1 parent fe8b233 commit b4c7cfe

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,25 @@ This repository contains codemods (automated migrations) for "userland" code. Th
1212
1313
To run the transform scripts use [`codemod`](https://go.codemod.com/github) command below:
1414

15-
```console
15+
### From registry
16+
17+
With the codemod CLI you can run a workflow from the [Codemod Registry](https://codemod.link/nodejs-official). Replace `<recipe>` with the name of the recipe you want to run:
18+
19+
```bash
1620
npx codemod @nodejs/<recipe>
1721
```
1822

23+
### From source
24+
25+
With the codemod CLI you can run a workflow from a local file. First, clone this repository, then run the command below from your project directory:
26+
27+
```bash
28+
git clone https://github.com/nodejs/userland-migrations.git
29+
cd /path/to/your-project
30+
npx codemod workflow run -w /path/to/folder/userland-migrations/recipes/<recipe>/workflow.yaml
31+
32+
```
33+
1934
See the [codemod CLI doc](https://go.codemod.com/cli-docs) for a full list of available commands.
2035

2136
## Available codemods

0 commit comments

Comments
 (0)