Skip to content

Commit cfad908

Browse files
committed
📚 Consistent cli commands
1 parent ee82986 commit cfad908

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

scripts/docs.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Migrates ${packageLink} to version ${key}.
7575
### Usage
7676
7777
\`\`\`
78-
$ @codeshift/cli --packages ${name}@${key} path/to/source
78+
$ codeshift-cli --packages ${name}@${key} path/to/source
7979
\`\`\`
8080
`,
8181
)
@@ -94,7 +94,7 @@ ${Object.keys(config.presets)
9494
### Usage
9595
9696
\`\`\`
97-
$ @codeshift/cli --packages ${name}#${key} path/to/source
97+
$ codeshift-cli --packages ${name}#${key} path/to/source
9898
\`\`\`
9999
`,
100100
)

website/docs/api/codeshift-cli.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The cli allows you to run transforms either from the [community folder](https://
2121

2222
We recommend running the CLI with `$ npx` to ensure you always have the latest version.
2323

24-
`$ npx @codeshift/cli --packages mylib@1.0.0 /project/src`
24+
`$ npx codeshift-cli --packages mylib@1.0.0 /project/src`
2525

2626
But it can also be installed normally:
2727

website/docs/consuming.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ For example, say we want to run transforms for `@mylib/button` and migrate from
1919
In this case we could try:
2020

2121
```
22-
npx @codemod/cli --package @mylib/button@14.0.0 project/path/to/src
22+
npx codemod-cli --package @mylib/button@14.0.0 project/path/to/src
2323
```
2424

2525
The following sequence of events will follow:
@@ -36,7 +36,7 @@ It's also possible to run a series of codemods, one after the other, to migrate
3636
This is done my providing the `--sequence` (or `-s`) flag to `@codemod/cli`.
3737

3838
```
39-
npx @codemod/cli --package @mylib/button@14.0.0 --sequence project/path/to/src
39+
npx codemod-cli --package @mylib/button@14.0.0 --sequence project/path/to/src
4040
```
4141

4242
This time around, we use the provided version (14.0.0) as the start of a semver range between `14.0.0-@latest`.
@@ -47,7 +47,7 @@ We then fetch all codemods that match and run them one after another.
4747
For codemods not published to the community repo, you can supply your own transform the same way you would with jscodeshift.
4848

4949
```
50-
npx @codemod/cli --transform path/to/transform.ts project/path/to/src
50+
npx codemod-cli --transform path/to/transform.ts project/path/to/src
5151
```
5252

5353
## Parsing TypeScript & Flow

0 commit comments

Comments
 (0)