Skip to content

Metrics

Generates GitHub profile stats as embeddable SVG, Markdown, PDF or JSON images.

Stars
17.4k
Forks
2.3k
Licence
MIT
Language
JavaScript
Last update
5 months ago
Type
Dev tool

What it is

Metrics is a tool that produces visual summaries of a GitHub account, such as languages used, commit activity, stars, and contributors. You run it as a GitHub Action, and it renders the result as an image or report you can place on your profile README or other pages. The README describes a large set of plugins and display options for customizing the output.

  • Embed an SVG summary of your commit and language activity in your profile README
  • Show starred repositories, licenses, or contributors for a project
  • Generate an isometric commit calendar for a profile page

Great for

  • Developers who want an automatically updated stats card on their GitHub profile README
  • Maintainers who want activity summaries for an organization or repository
  • People who prefer generated SVG images they control over third-party stats widgets

Not ideal for

  • People who want a no-setup hosted service, since the README centers on running it yourself (the truncated README does not show a hosted-only path)
  • Users who need a PDF or JSON export without reading setup docs, because the truncated README does not explain those steps
Step-by-step guide: how to use MetricsInstall, first run, examples, tips and FAQs

How to get it

  1. 1

    See the README

    Clone the repository

    git clone https://github.com/lowlighter/metrics
  2. 2

    Run it

    • Read the setup section of the README at the repository URL
    • Configure the GitHub Action or self-hosted setup as the README describes
    • Add the generated image link to your profile README
  3. 3

    Get the most out of it

    • Explore the per-plugin READMEs linked from the main README
    • Try the isometric commit calendar plugin for a visual year overview
    • Use the organization view if you manage a GitHub org

Downloads

Strengths

  • Large set of plugins and options (the README cites 47 plugins and 335 options)
  • Output can be embedded as images in many places, per the README
  • MIT licensed and actively maintained, with a recent push date

Trade-offs

  • Many options can make configuration complex for newcomers
  • The truncated README does not show full setup steps, so exact installation is unclear here
  • Some plugins depend on GitHub API access and may need a token

How it compares

ProjectStarsTypeLevelUpdatedBest for
metrics (this)17.4kDev toolintermediate5 months agoDevelopers who want an automatically updated stats card on their GitHub profile README
github-readme-stats79.9kDev toolbeginner1 months agoPeople who want a generated stats card on their GitHub profile README
Badges4-README.md-Profile13.6kCurated listbeginner1 months agoDevelopers who want a tidy tech-stack section on their GitHub profile
readme-md-generator11.1kCLIbeginner4.1 years agoDevelopers starting a new project who want a README without writing one by hand
github-trends15.9kAppbeginner1.8 years agoDevelopers who want a profile card showing lines of code by language or repository
supervision51.5kLibraryintermediate4 days agoPython developers building apps on top of object detection or segmentation models

Stats synced from GitHub. The assessment above was drafted with AI from the project's README on 2026-10-29 and may miss recent changes — check the README before relying on a command. MIT licence: free to use, modify and distribute, including commercially, as long as you keep the copyright notice.