Skip to content

docs(create-cli): fix CLI options in README examples#1272

Merged
hanna-skryl merged 1 commit intomainfrom
create-cli-readme
Mar 19, 2026
Merged

docs(create-cli): fix CLI options in README examples#1272
hanna-skryl merged 1 commit intomainfrom
create-cli-readme

Conversation

@hanna-skryl
Copy link
Collaborator

@hanna-skryl hanna-skryl commented Mar 18, 2026

Summary

  • Add -- separator in README examples that pass CLI options to the wizard

The setup wizard introduced CLI options like --dry-run and --yes. These conflict with npm init's own options. As a result, npm silently consumes them before they reach the create-cli package. A -- separator is needed to forward options correctly.

@hanna-skryl hanna-skryl self-assigned this Mar 18, 2026
@github-actions github-actions bot added the 📖 Project documentation improvements or additions to the project documentation label Mar 18, 2026
@nx-cloud
Copy link

nx-cloud bot commented Mar 18, 2026

View your CI Pipeline Execution ↗ for commit 3cc3b01

Command Status Duration Result
nx run ci:code-pushup -- merge-diffs --files=/h... ✅ Succeeded 5s View ↗
nx run-many --targets=code-pushup --parallel=fa... ✅ Succeeded 1m 31s View ↗
nx run-many --targets=code-pushup --parallel=fa... ✅ Succeeded 13m 46s View ↗
nx run-many -t unit-test,int-test ✅ Succeeded 2m 4s View ↗

☁️ Nx Cloud last updated this comment at 2026-03-18 18:51:08 UTC

@pkg-pr-new
Copy link

pkg-pr-new bot commented Mar 18, 2026

Open in StackBlitz

@code-pushup/ci

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/ci@1272

@code-pushup/cli

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/cli@1272

@code-pushup/core

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/core@1272

@code-pushup/create-cli

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/create-cli@1272

@code-pushup/models

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/models@1272

@code-pushup/nx-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/nx-plugin@1272

@code-pushup/axe-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/axe-plugin@1272

@code-pushup/coverage-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/coverage-plugin@1272

@code-pushup/js-packages-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/js-packages-plugin@1272

@code-pushup/jsdocs-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/jsdocs-plugin@1272

@code-pushup/eslint-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/eslint-plugin@1272

@code-pushup/lighthouse-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/lighthouse-plugin@1272

@code-pushup/typescript-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/typescript-plugin@1272

@code-pushup/utils

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/utils@1272

commit: 3cc3b01

@github-actions
Copy link
Contributor

github-actions bot commented Mar 18, 2026

Code PushUp

🤨 Code PushUp report has both improvements and regressions – compared current commit 163d470 with previous commit 28ccfcb.

🕵️ See full comparison in Code PushUp portal 🔍

🏷️ Categories

🏷️ Category ⭐ Previous score ⭐ Current score 🔄 Score change
Performance 🔴 36 🔴 34 ↓ −1.5
Bug prevention 🟡 75 🟡 75 ↓ −0.1
Axe Accessibility 🟡 88 🟡 88 ↓ −0.1
Code style 🟢 100 🟢 100
Code coverage 🟢 92 🟢 92
Security 🔴 0 🔴 0
Updates 🟡 72 🟡 72
Type Safety 🟡 67 🟡 67
Miscellaneous 🟡 67 🟡 67
Documentation 🟡 52 🟡 52
Accessibility 🟢 92 🟢 92
Best Practices 🟢 100 🟢 100
SEO 🟢 92 🟢 92
👎 1 group regressed, 👍 1 audit improved, 👎 3 audits regressed, 13 audits changed without impacting score

🗃️ Groups

🔌 Plugin 🗃️ Group ⭐ Previous score ⭐ Current score 🔄 Score change
Lighthouse Performance 🔴 36 🔴 34 ↓ −1.5

33 other groups are unchanged.

🛡️ Audits

🔌 Plugin 🛡️ Audit 📏 Previous value 📏 Current value 🔄 Value change
Lighthouse Initial server response time was short 🟩 Root document took 500 ms 🟥 Root document took 690 ms ↑ +38 %
Lighthouse Speed Index 🟥 6.1 s 🟥 7.0 s ↑ +15 %
Lighthouse Max Potential First Input Delay 🟥 710 ms 🟥 600 ms ↓ −15.6 %
Lighthouse Total Blocking Time 🟥 2,050 ms 🟥 2,210 ms ↑ +7.8 %
Lighthouse Avoids enormous network payloads 🟩 Total size was 2,417 KiB 🟩 Total size was 2,407 KiB ↓ −0.4 %
Lighthouse Server Backend Latencies 🟩 1,390 ms 🟩 320 ms ↓ −77.1 %
Lighthouse Largest Contentful Paint 🟥 14.0 s 🟥 13.1 s ↓ −6.3 %
Lighthouse JavaScript execution time 🟥 3.3 s 🟥 4.0 s ↑ +20.7 %
Lighthouse Reduce unused JavaScript 🟥 Potential savings of 298 KiB 🟥 Potential savings of 297 KiB ↓ −32 %
Lighthouse Remove duplicate modules in JavaScript bundles 🟥 Potential savings of 112 KiB 🟥 Potential savings of 108 KiB ↓ −46.4 %
Lighthouse Minimizes main-thread work 🟥 10.3 s 🟥 10.6 s ↑ +2.7 %
Lighthouse Uses efficient cache policy on static assets 🟨 31 resources found 🟨 31 resources found ↑ +0.1 %
Lighthouse Reduce unused CSS 🟥 Potential savings of 111 KiB 🟥 Potential savings of 111 KiB ↑ +22 %
Lighthouse Metrics 🟩 100% 🟩 100% ↓ −0.2 %
Lighthouse Time to Interactive 🟥 14.7 s 🟥 14.7 s ↓ −0.2 %
Lighthouse Network Round Trip Times 🟩 50 ms 🟩 60 ms ↑ +20 %
Lighthouse First Contentful Paint 🟥 3.3 s 🟥 3.3 s ↓ −0.3 %

661 other audits are unchanged.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 18, 2026

Code PushUp

😐 Code PushUp report is unchanged – compared current commit 163d470 with previous commit 28ccfcb.


All of 14 projects are unchanged.

@hanna-skryl hanna-skryl marked this pull request as ready for review March 18, 2026 14:24
@hanna-skryl hanna-skryl requested a review from matejchalk March 18, 2026 14:24
@hanna-skryl hanna-skryl changed the title docs(create-cli): use npx as primary command in README docs(create-cli): fix CLI options in README examples Mar 19, 2026
@hanna-skryl hanna-skryl merged commit daa6ccb into main Mar 19, 2026
27 checks passed
@hanna-skryl hanna-skryl deleted the create-cli-readme branch March 19, 2026 12:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📖 Project documentation improvements or additions to the project documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants