What it is

Metrics is an infographics generator for GitHub accounts, published under the MIT license and written in JavaScript. It lives in the GitHub ecosystem as a GitHub Action and as a hosted web service, and it produces statistics about a user, an organization, or a repository. The output is rendered as SVG, Markdown, PDF, or JSON, which means the same generated figures can be embedded in a profile readme, attached to a blog post, or consumed by another tool.

The concrete problem it solves is the gap between raw GitHub data and something presentable. GitHub exposes commits, languages, stargazers, sponsorships, issues, pull requests, and traffic through its API, but turning that into a readable summary normally means writing custom scripts and hand-maintaining charts. Metrics packages that work into a configurable generator with 47 plugins and 335 options, so a profile owner declares which plugins to run and receives a rendered image or document instead of building the pipeline themselves. It covers users, organizations, and repositories, and it ships with the classic, repository, terminal, and Markdown templates.

Key capabilities

• Generates isometric commit calendars, including full-year, half-year, and indepth analysis modes that clone and analyze repositories.
• Reports languages activity through a default algorithm or a detailed variant, and can analyze recent activity events instead of full history.
• Produces lines-of-code-changed charts, stargazer charts, and repository diff history.
• Renders repository licenses, coding habits and activity, and mildly interesting facts.
• Tracks repository contributors, issue and pull request follow-up, and comment reactions.
• Displays GitHub Sponsorships, featured repositories, discussions, star lists, and achievements.
• Supports community plugins such as 16personalities, Chess, Crypto, Fortune, Nightscout, PoopMap, website screenshot, Splatoon, and stock prices.

Who uses it and how

• Profile owners embed generated SVG images in a GitHub profile readme to summarize account activity.
• Organizations run it to display aggregate statistics across their repositories.
• Repository maintainers use it to surface contributors, licenses, and issue and pull request activity.
• Users deploy it through a GitHub Action on a profile repository, which the documentation describes as covering all features with high availability and no downtimes.
• Users who want a faster path rely on the shared instance, which the documentation lists as roughly a one-minute setup.

Getting started

Setup runs either as a GitHub Action on a profile repository, which takes roughly ten minutes and exposes all features, or through the shared instance at metrics.lecoq.io, which takes roughly one minute. A beta instance is available for testing unreleased features and patches.

When to use it — and when not to

The project replaces the manual work of scripting GitHub API calls and chart rendering, and it does so without a paid product in the facts listed here. The trade-off is configuration: the documentation itself notes that the GitHub Action route can be time-consuming to set up, and the option surface of 335 settings across 47 plugins is large. Note also that the documentation excerpt describes v3.35-beta on the master and main branches, while v3.34 is the current released version, so self-hosters should pin to the released branch unless they intend to track unreleased features.

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </td>

  </details>
</th>

  </details>
</th>

  </details>
</th>

  </details>
</th>

  </details>
</th>

  </details>
</th>

  </details>
</th>

  </details>
</th>

  </details>
</th>

  </td>

  </td>

  </td>

  </td>

MIT License
Copyright (c) 2020-present lowlighter