Skip to content

Latest commit

 

History

History
52 lines (36 loc) · 2.06 KB

File metadata and controls

52 lines (36 loc) · 2.06 KB

@code-pushup/create-cli

npm downloads dependencies

An interactive setup wizard that scaffolds a code-pushup.config.ts file in your repository.

Usage

npm init @code-pushup/cli

The wizard will prompt you to select plugins and configure their options, then generate a code-pushup.config.ts file.

Options

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

Examples

Run interactively (default):

npm init @code-pushup/cli

Skip prompts and enable specific plugins:

npm init @code-pushup/cli -y --plugins=eslint,coverage

Set up a monorepo with GitHub CI integration:

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

Preview the generated config without writing:

npm init @code-pushup/cli -y --dry-run