Skip to content

docs(create-cli): document all CLI options in README #1268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hanna-skryl wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(create-cli): document all CLI options in README #1268

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions packages/create-cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,14 @@ The wizard will prompt you to select plugins and configure their options, then g

## Options

| Flag | Description | Default |
| ------------- | -------------------------------------- | ------- |
| `--plugins` | Comma-separated plugin slugs to enable | |
| `--dry-run` | Preview changes without writing files | `false` |
| `--yes`, `-y` | Skip prompts and use defaults | `false` |
| Flag | Description | Default |
| ----------------- | ---------------------------------------------- | ------------- |
| `--plugins` | Comma-separated plugin slugs to enable | |
| `--config-format` | Config file format (`ts`, `js`, `mjs`) | auto-detected |
| `--mode` | Setup mode (`standalone`, `monorepo`) | auto-detected |
| `--ci` | CI/CD integration (`github`, `gitlab`, `none`) | |
| `--dry-run` | Preview changes without writing files | `false` |
| `--yes`, `-y` | Skip prompts and use defaults | `false` |

### Examples

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

Set up a monorepo with GitHub CI integration:

```bash
npm init @code-pushup/cli --mode=monorepo --ci=github
```

Preview the generated config without writing:

```bash
Expand Down
Loading