README.md

@code-pushup/core

🔎🔬 Quality metrics for your software project. 📉🔍

1. ⚙️ Configure what you want to track using your favourite tools.
2. 🤖 Integrate it in your CI.
3. 🌈 Visualize reports in a beautiful dashboard.

---

This package contains the core business logic for the Code PushUp CLI.

For most use cases, you'll probably want to use the @code-pushup/cli package instead. The core package is useful if you prefer programmatic usage (avoids going through the command line).

Setup

npm install --save-dev @code-pushup/core

yarn add --dev @code-pushup/core

pnpm add --save-dev @code-pushup/core

Usage

import { collect } from '@code-pushup/core';

const report = await collect({
  // ...
});