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

[hanna-skryl]

Document --config-format, --mode, and --ci options that were missing from the README and add a monorepo + CI usage example.

[nx-cloud]

View your CI Pipeline Execution ↗ for commit c2c6ff8

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 37s	View ↗
nx run-many -t unit-test,int-test	✅ Succeeded	2m 5s	View ↗

---

☁️ Nx Cloud last updated this comment at 2026-03-13 23:08:25 UTC

[pkg-pr-new]

Open in StackBlitz

@code-pushup/ci

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

@code-pushup/cli

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

@code-pushup/core

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

@code-pushup/create-cli

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

@code-pushup/models

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

@code-pushup/nx-plugin

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

@code-pushup/axe-plugin

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

@code-pushup/eslint-plugin

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

@code-pushup/coverage-plugin

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

@code-pushup/js-packages-plugin

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

@code-pushup/jsdocs-plugin

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

@code-pushup/lighthouse-plugin

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

@code-pushup/typescript-plugin

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

@code-pushup/utils

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

commit: c2c6ff8

[github-actions]

Code PushUp

🤨 Code PushUp report has both improvements and regressions – compared current commit cbd7d9c with previous commit d13cc6e.

🕵️ See full comparison in Code PushUp portal 🔍

🏷️ Categories

🏷️ Category	⭐ Previous score	⭐ Current score	🔄 Score change
Performance	🔴 35	🔴 34
Updates	🟡 73	🟡 72
Bug prevention	🟡 75	🟡 75
Documentation	🟡 52	🟡 52
Axe Accessibility	🟡 88	🟡 88
Code style	🟢 100	🟢 100	–
Code coverage	🟢 92	🟢 92	–
Security	🔴 0	🔴 0	–
Type Safety	🟡 67	🟡 67	–
Miscellaneous	🟡 67	🟡 67	–
Accessibility	🟢 92	🟢 92	–
Best Practices	🟢 100	🟢 100	–
SEO	🟢 92	🟢 92	–

👎 3 groups regressed, 👍 4 audits improved, 👎 3 audits regressed, 14 audits changed without impacting score

🗃️ Groups

🔌 Plugin	🗃️ Group	⭐ Previous score	⭐ Current score	🔄 Score change
Lighthouse	Performance	🔴 35	🔴 34
JS packages	npm outdated dependencies	🟡 73	🟡 72
JSDocs coverage	Documentation coverage	🟡 52	🟡 52

31 other groups are unchanged.

🛡️ Audits

🔌 Plugin	🛡️ Audit	📏 Previous value	📏 Current value	🔄 Value change
Lighthouse	Initial server response time was short	🟥 Root document took 740 ms	🟩 Root document took 390 ms
Lighthouse	Remove duplicate modules in JavaScript bundles	🟥 Potential savings of 102 KiB	🟨 Potential savings of 103 KiB
Lighthouse	First Contentful Paint	🟥 3.4 s	🟥 3.1 s
Lighthouse	Total Blocking Time	🟥 2,090 ms	🟥 4,830 ms
JS packages	Outdated npm dev dependencies.	🟨 61 outdated package versions (30 major, 25 minor, 6 patch)	🟨 61 outdated package versions (32 major, 24 minor, 5 patch)
Lighthouse	Max Potential First Input Delay	🟥 660 ms	🟥 1,380 ms
Lighthouse	Speed Index	🟥 6.4 s	🟥 6.4 s
Lighthouse	Avoids enormous network payloads	🟩 Total size was 2,386 KiB	🟩 Total size was 2,408 KiB
Lighthouse	Minimizes main-thread work	🟥 9.1 s	🟥 16.7 s
Lighthouse	JavaScript execution time	🟥 2.9 s	🟥 5.4 s
Lighthouse	Server Backend Latencies	🟩 1,320 ms	🟩 170 ms
Lighthouse	Largest Contentful Paint	🟥 13.8 s	🟥 12.9 s
Lighthouse	Reduce unused JavaScript	🟥 Potential savings of 322 KiB	🟥 Potential savings of 276 KiB
Lighthouse	Uses efficient cache policy on static assets	🟨 31 resources found	🟨 31 resources found
Lighthouse	Network Round Trip Times	🟩 50 ms	🟩 10 ms
Lighthouse	Reduce unused CSS	🟥 Potential savings of 111 KiB	🟥 Potential savings of 80 KiB
Lighthouse	Time to Interactive	🟥 14.6 s	🟥 14.6 s
Lighthouse	Metrics	🟩 100%	🟩 100%
JS packages	Vulnerabilities for npm prod dependencies.	🟥 18 vulnerabilities (2 critical, 6 high, 3 moderate, 7 low)	🟥 23 vulnerabilities (2 critical, 7 high, 8 moderate, 6 low)
Lighthouse	Avoids an excessive DOM size	🟥 2,341 elements	🟥 2,340 elements
Lighthouse	Cumulative Layout Shift	🟩 0	🟩 0

657 other audits are unchanged.

[github-actions]

Code PushUp

😐 Code PushUp report is unchanged – compared current commit cbd7d9c with previous commit d13cc6e.

---

All of 14 projects are unchanged.