|
1 |
| -# Code PushUp - Just Follow the Score <✓> |
| 1 | +# Code PushUp CLI |
2 | 2 |
|
3 |
| -**🔎🔬 Code quality integrations for any tool 📉🔍** |
| 3 | +**Comprehensive tech quality monitoring <✓>** |
4 | 4 |
|
5 | 5 | [](https://www.npmjs.com/package/%40code-pushup%2Fcli)
|
6 | 6 | [](https://github.com/code-pushup/cli/releases)
|
|
9 | 9 | [](https://github.com/code-pushup/cli/actions/workflows/ci.yml?query=branch%3Amain)
|
10 | 10 | [](https://codecov.io/gh/code-pushup/cli)
|
11 | 11 |
|
12 |
| -## 🌟 Why Choose Code PushUp? |
| 12 | +--- |
13 | 13 |
|
14 | 14 | ### 🔌 Code quality tools are like phone chargers. Everyone has a different plug.
|
15 | 15 |
|
16 |
| -- **Incomplete or missing tracking** due to a mix of portals and custom tools is costly and unreliable 💸 |
17 |
| -- **No Standards** in data and processes leads to flaky, unmaintained zombies 🧟 |
18 |
| -- **Results are spread** over multiple places and need manual steps 📂 |
19 |
| - |
20 |
| -## 🛠️ Standards for Code Quality that Integrates Any Tool |
| 16 | +_Common problems with keeping track of technical quality:_ |
21 | 17 |
|
22 |
| -### 🚀 Automated CI Integration |
| 18 | +- When **tech debt is invisible**, it's difficult to plan much-needed maintenance efforts 🔧 |
| 19 | +- Individual tools measure different metrics, inability to combine them leads to |
| 20 | + a **lack of comprehensive overview** 🧑🦯 |
| 21 | +- Open-source tools typically used for failing checks in CI, which **can't measure incremental improvements** due to arbitrary pass/fail thresholds 🤖 |
| 22 | +- Off-the-shelf solutions tend to be opinionated and **hard to customize**, so may not fit your specific needs 🧱 |
23 | 23 |
|
24 |
| -- **Seamless integration** into any CI pipeline with full control. ⚙️ |
25 |
| -- Our tool **works on all platforms** like GitHub, Gitlab, etc. 🌐 |
26 |
| -- Even custom tooling can be created over the 📦 [@code-pushup/core](./packages/core#readme) package |
27 |
| -- Get updates [on every PR](https://github.com/marketplace/actions/code-pushup)! 🔄 |
| 24 | +_We want to change that!_ |
28 | 25 |
|
29 | 26 | ---
|
30 | 27 |
|
31 |
| -### ⚡ Flexible Config Setup |
| 28 | +## 🔎🔬 Code quality integrations for any tool 📉🔍 |
32 | 29 |
|
33 |
| -- **[📦 CLI](./packages/cli#readme)** for **collecting** audit results and **uploading** reports to the portal. |
34 |
| -- **[📦 Core Logic](./packages/core#readme)** to craft your **custom tooling**. |
| 30 | +| [🚀 Get started](./packages/cli/README.md#getting-started)️ | [🤖 CI automation](https://github.com/marketplace/actions/code-pushup) | |
| 31 | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
| 32 | +| <a href="./packages/cli/README.md#getting-started"><img alt="Getting started cover image" title="Getting started with code-pushup" src="packages/cli/docs/images/cli-terminal-overview.png" max-height="200" width="auto"></a> | <a href="./packages/cli/README.md#-ci-automation"><img alt="CI Automation cover" title="CI automation guide" src="docs/images/gh-action.png" max-height="200" width="auto"></a> | |
| 33 | +| <ul><li>Run **[📦 `@code-pushup/cli`](./packages/cli#readme)** to collect **reports**.</li><li>[Get started](./packages/cli/README.md#getting-started) quickly with our [**official plugins**](#-officially-supported-plugins)! ⏱️</li></ul> | <ul><li>Easy **CI** setup with **[🤖 `code-pushup/github-action`](https://github.com/marketplace/actions/code-pushup)**.</li><li>Import logic from **[📦 `@code-pushup/core`](./packages/core#readme)** to craft **custom tools**.</li></ul> | |
35 | 34 |
|
36 |
| -[Get started in no time!](./packages/cli/README.md#getting-started) ⏱️ |
| 35 | +| 📈 [Portal](https://code-pushup.dev#portal)️ | 🔌 [Custom plugins](./packages/cli/docs/custom-plugins.md) | |
| 36 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
| 37 | +| <a href="#portal-integration"><img alt="Portal integration cover image" title="Inetegrate code-pushup portal" src="packages/cli/docs/images/portal-cover.png" max-height="200" width="auto"></a> | <a href="#custom-plugins"><img alt="Custom plugins" title="Create custom code-pushup plugins" src="docs/images/code-pushup-custom-plugins.png" max-height="200" width="auto"></a> | |
| 38 | +| <ul><li>**[Portal](https://code-pushup.dev#portal)** 🌐 **visualizes reports** in a slick UI.</li><li>Track **historical data** from uploads. ⬆️</li></ul> | <ul><li>All the [data models](./packages/models/docs/models-reference.md) you need are provided in **[📦 `@code-pushup/models`](./packages/models/README.md)**.</li><li>Find tons of useful utilities in **[📦 `@code-pushup/utils`](./packages/utils/README.md)**.</li></ul> | |
37 | 39 |
|
38 | 40 | ---
|
39 | 41 |
|
|
48 | 50 |
|
49 | 51 | ---
|
50 | 52 |
|
51 |
| -### 🔧 Custom Plugins |
52 |
| - |
53 |
| -- 🛠️ [Integrate your own metric with custom plugins](./packages/cli/docs/custom-plugins.md) 📚 |
54 |
| -- 📦 [@code-pushup/models](./packages/models#readme) |
55 |
| - - **Schemas and types** for data models (useful for custom plugins or other integrations) 📊 |
56 |
| -- 📦 [@code-pushup/utils](./packages/utils#readme) |
57 |
| - - Various **utilities** (useful for custom plugins or other integrations) 🔨 |
58 |
| - |
59 |
| ---- |
60 |
| - |
61 | 53 | ## 📝 How It Works!
|
62 | 54 |
|
63 |
| -1. **Configure** |
| 55 | +1. **[Configure](./packages/cli/README.md#getting-started)** |
64 | 56 | Pick from a set of supported packages or include your own ideas. 🧩
|
65 | 57 |
|
66 |
| -2. **Integrate** |
| 58 | +2. **[Integrate](https://github.com/marketplace/actions/code-pushup)** |
67 | 59 | Use our integration guide and packages to set up CI integration in minutes. ⏱️
|
68 | 60 |
|
69 |
| -3. **Observe** |
| 61 | +3. **[Observe](https://code-pushup.dev#portal)** |
70 | 62 | Guard regressions and track improvements with every code change. 🔍
|
71 | 63 |
|
72 |
| -4. **Wing it!** |
| 64 | +4. **Relax!** |
73 | 65 | Watch improvements, share reports 📈
|
74 | 66 |
|
75 | 67 | ---
|
76 | 68 |
|
77 | 69 | <table>
|
78 | 70 | <tr>
|
79 | 71 | <td>
|
80 |
| -<img alt="Code-Pushup Logo" src="./packages/cli/docs/images/code-pushup-logo.png" width="150px" height="192px"> |
| 72 | +<img alt="Code-Pushup Logo" src="./packages/cli/docs/images/code-pushup-logo.png" width="730"> |
81 | 73 | </td>
|
82 | 74 | <td>
|
83 |
| -<h2>Just follow the score</h2> |
84 |
| -<h3>See regressions - Report scores - On every PR</h3> |
| 75 | +<h2>Comprehensive tech quality monitoring <✓></h2> |
| 76 | +<h3>Monitor regressions - Quantify tech debt</h3> |
85 | 77 | <!-- link when web landing is ready <a href="./packages/cli/README.md#getting-started">Try our paid features</a> -->
|
86 | 78 | </td>
|
87 | 79 | </tr>
|
|
0 commit comments