Code PushUp CLI

Comprehensive tech quality monitoring

Quantify tech debt — Track incremental improvements — Monitor regressions

---

---

🏷️ Category labels

See how your project measures up. With portal integration, category scores are embeddable and always reflect your latest report.

---

🔌 Code quality tools are like phone chargers. Everyone has a different plug.

Common problems with keeping track of technical quality:

• When tech debt is invisible, it's difficult to plan much-needed maintenance efforts 🔧
• Individual tools measure different metrics, the inability to combine them leads to a lack of comprehensive overview 🧑‍🦯
• Open-source tools typically used for failing checks in CI, which can't measure incremental improvements due to arbitrary pass/fail thresholds 🤖
• Off-the-shelf solutions tend to be opinionated and hard to customize, so may not fit your specific needs 🧱

We want to change that!

---

🔎🔬 Code quality integrations for any tool 📉🔍

🚀 Get started️	🤖 CI automation
Run 📦 @code-pushup/cli to collect reports. Get started quickly with our official plugins! ⏱️	Easy CI setup with 🤖 code-pushup/github-action. Import logic from 📦 @code-pushup/core to craft custom tools.

📈 Portal️	🔌 Custom plugins
Portal 🌐 visualizes reports in a slick UI. Track historical data from uploads. ⬆️	All the data models you need are provided in 📦 @code-pushup/models. Find tons of useful utilities in 📦 @code-pushup/utils.

---

🔌 Officially supported plugins

Icon	Name	Description
	ESLint	Static analysis using ESLint rules.
	Code Coverage	Collects code coverage from your tests.
	JS Packages	Checks 3rd party packages for known vulnerabilities and outdated versions.
	Lighthouse	Measures web performance and best practices with Lighthouse.
	JSDocs	Analyzes how much source code is documented using JSDocs comments.
	TypeScript	Checks for TypeScript errors using strict compiler flags.
	Axe	Detects accessibility issues using Axe.

---

📝 How it works

1. Configure
   Pick from a set of supported packages or include your own ideas. 🧩

2. Integrate
   Use our integration guide and packages to set up CI integration in minutes. ⏱️

3. Observe
   Guard regressions and track improvements with every code change. 🔍

4. Relax!
   Watch improvements, share reports 📈

---

💖 Want to support us?

• Read how to contribute to the codebase. See: CONTRIBUTING.md 🤝