Skip to content

Commit 6256c99

Browse files
committed
docs(create-cli): use npx as primary command in README
1 parent 28ccfcb commit 6256c99

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

packages/create-cli/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ An interactive setup wizard that scaffolds a `code-pushup.config.ts` file in you
99
## Usage
1010

1111
```bash
12-
npm init @code-pushup/cli
12+
npx @code-pushup/create-cli
1313
```
1414

1515
The wizard will prompt you to select plugins and configure their options, then generate a `code-pushup.config.ts` file.
@@ -42,23 +42,23 @@ Each plugin exposes its own configuration keys that can be passed as CLI argumen
4242
Run interactively (default):
4343

4444
```bash
45-
npm init @code-pushup/cli
45+
npx @code-pushup/create-cli
4646
```
4747

4848
Skip prompts and enable specific plugins:
4949

5050
```bash
51-
npm init @code-pushup/cli -y --plugins=eslint,coverage
51+
npx @code-pushup/create-cli -y --plugins=eslint,coverage
5252
```
5353

5454
Set up a monorepo with GitHub CI integration:
5555

5656
```bash
57-
npm init @code-pushup/cli --mode=monorepo --ci=github
57+
npx @code-pushup/create-cli --mode=monorepo --ci=github
5858
```
5959

6060
Preview the generated config without writing:
6161

6262
```bash
63-
npm init @code-pushup/cli -y --dry-run
63+
npx @code-pushup/create-cli -y --dry-run
6464
```

0 commit comments

Comments
 (0)