Skip to content

Commit

Permalink
docs: add logs command (#1279)
Browse files Browse the repository at this point in the history
  • Loading branch information
mohab-sameh authored Aug 26, 2024
1 parent 10f6f49 commit 2352650
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions apps/docs/deploying-codemods/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -300,9 +300,7 @@ codemod [codemod-name] --no-interactive
</ResponseField>
</ResponseField>
<ResponseField name="--engine" type="boolean">
<ResponseField name="--engine" type="string">
Used to specify the engine for standalone codemod runs.
<Note>When running standalone codemods (the ones that do not have a [codemod-compatible directory structure](/codemod-registry/introduction#required-codemod-package-structure)), you will be prompted to select a codemod engine that your codemod was built with. To support non-interactive mode, we added this optional flag.</Note>
Expand Down Expand Up @@ -330,6 +328,21 @@ codemod [codemod-name] -n [number-of-threads]
```
</ResponseField>
<ResponseField name="--log" type="boolean">
Can be used to generate a log file when running a codemod.
```bash
codemod [codemod-name] --logs
```
You can then open the log file by running:
```bash
codemod --logs
```
</ResponseField>
## Other commands
<ResponseField name="codemod login">
Expand Down

0 comments on commit 2352650

Please sign in to comment.