https://github.com/code-pushup/cli
A CLI to run all kinds of code quality measurements to align your team with company goals
https://github.com/code-pushup/cli
analytics analyzer audit automated-testing conformance gatekeeper kpi quality-control regression-analysis static-analysis
Last synced: about 1 month ago
JSON representation
A CLI to run all kinds of code quality measurements to align your team with company goals
- Host: GitHub
- URL: https://github.com/code-pushup/cli
- Owner: code-pushup
- License: mit
- Created: 2023-08-16T10:50:24.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-14T15:38:15.000Z (about 1 month ago)
- Last Synced: 2025-05-15T00:05:01.322Z (about 1 month ago)
- Topics: analytics, analyzer, audit, automated-testing, conformance, gatekeeper, kpi, quality-control, regression-analysis, static-analysis
- Language: TypeScript
- Homepage: https://code-pushup.dev
- Size: 14.5 MB
- Stars: 328
- Watchers: 3
- Forks: 15
- Open Issues: 69
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
Code PushUp CLI
Comprehensive tech quality monitoring
Quantify tech debt — Track incremental improvements — Monitor regressions
---
[](https://github.com/code-pushup/cli/releases/latest)
[](https://github.com/code-pushup/cli/releases)
[](https://opensource.org/licenses/MIT)
[](https://github.com/code-pushup/cli/pulse/monthly)
[](https://github.com/code-pushup/cli/actions/workflows/ci.yml?query=branch%3Amain)
[](https://codecov.io/gh/code-pushup/cli)
---
### 🔌 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, 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](./packages/cli/README.md#getting-started)️ | [🤖 CI automation](https://github.com/marketplace/actions/code-pushup) |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 
| 
|
|
- Run **[📦 `@code-pushup/cli`](./packages/cli#readme)** to collect **reports**.
- [Get started](./packages/cli/README.md#getting-started) quickly with our [**official plugins**](#-officially-supported-plugins)! ⏱️
- Easy **CI** setup with **[🤖 `code-pushup/github-action`](https://github.com/marketplace/actions/code-pushup)**.
- Import logic from **[📦 `@code-pushup/core`](./packages/core#readme)** to craft **custom tools**.
| 📈 [Portal](https://code-pushup.dev#portal)️ | 🔌 [Custom plugins](./packages/cli/docs/custom-plugins.md) |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 
| 
|
|
- **[Portal](https://code-pushup.dev#portal)** 🌐 **visualizes reports** in a slick UI.
- Track **historical data** from uploads. ⬆️
- All the [data models](./packages/models/docs/models-reference.md) you need are provided in **[📦 `@code-pushup/models`](./packages/models/README.md)**.
- Find tons of useful utilities in **[📦 `@code-pushup/utils`](./packages/utils/README.md)**.
---
### 🔌 Officially supported plugins
| Icon | Name | Description |
| :------------------------------------------------------------: | :-------------------------------------------------- | :--------------------------------------------------------------------------------- |
| 
| [ESLint](./packages/plugin-eslint#readme) | Static analysis using **ESLint** rules. |
| 
| [Code Coverage](./packages/plugin-coverage#readme) | Collects code **coverage** from your tests. |
| 
| [JS Packages](./packages/plugin-js-packages#readme) | Checks 3rd party packages for known **vulnerabilities** and **outdated** versions. |
| 
| [Lighthouse](./packages/plugin-lighthouse#readme) | Measures web performance and best practices with **Lighthouse**. |
| 
| [JSDocs](./packages/plugin-jsdocs#readme) | Analyzes how much source code is **documented** using JSDocs comments. |
| 
| [TypeScript](./packages/plugin-typescript#readme) | Checks for **TypeScript** errors using strict compiler flags. |
---
## 📝 How it works
1. **[Configure](./packages/cli/README.md#getting-started)**
Pick from a set of supported packages or include your own ideas. 🧩
2. **[Integrate](https://github.com/marketplace/actions/code-pushup)**
Use our integration guide and packages to set up CI integration in minutes. ⏱️
3. **[Observe](https://code-pushup.dev#portal)**
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](./CONTRIBUTING.md) 🤝