Skip to content

Commit 6eadfac

Browse files
committed
docs(create-cli): document all CLI options in README
1 parent d13cc6e commit 6eadfac

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

packages/create-cli/README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,14 @@ The wizard will prompt you to select plugins and configure their options, then g
1616

1717
## Options
1818

19-
| Flag | Description | Default |
20-
| ------------- | -------------------------------------- | ------- |
21-
| `--plugins` | Comma-separated plugin slugs to enable | |
22-
| `--dry-run` | Preview changes without writing files | `false` |
23-
| `--yes`, `-y` | Skip prompts and use defaults | `false` |
19+
| Option | Type | Default | Description |
20+
| --------------------- | ------------------------------------ | ------------- | -------------------------------------- |
21+
| **`--plugins`** | `string[]` | | Comma-separated plugin slugs to enable |
22+
| **`--config-format`** | `'ts'` \| `'js'` \| `'mjs'` | auto-detected | Config file format |
23+
| **`--mode`** | `'standalone'` \| `'monorepo'` | auto-detected | Setup mode |
24+
| **`--ci`** | `'github'` \| `'gitlab'` \| `'none'` | | CI/CD integration |
25+
| **`--dry-run`** | `boolean` | `false` | Preview changes without writing files |
26+
| **`--yes`**, `-y` | `boolean` | `false` | Skip prompts and use defaults |
2427

2528
### Examples
2629

@@ -36,6 +39,12 @@ Skip prompts and enable specific plugins:
3639
npm init @code-pushup/cli -y --plugins=eslint,coverage
3740
```
3841

42+
Set up a monorepo with GitHub CI integration:
43+
44+
```bash
45+
npm init @code-pushup/cli --mode=monorepo --ci=github
46+
```
47+
3948
Preview the generated config without writing:
4049

4150
```bash

0 commit comments

Comments
 (0)