GitHub Profile Stats for Your README
default
A live GitHub stats card for your profile
GHStats turns your public GitHub activity into an SVG card you can embed in a profile README. Show the numbers that matter to you, including commits, stars, pull requests, contributions, streaks, repositories and followers. The card refreshes as your public activity changes, so you do not need to edit your README each time.
Profile stats card
Put your GitHub user stats in one card, then choose which metrics and theme to display.
Top languages
Add a separate languages card when you want your profile to show the languages in your public repositories.
Badges and activity
Use a compact stats badge or contribution sparkline when a full-size card does not fit your README.
Quick Start
1Create your profile README
GitHub displays a special README on your profile when you create a repo with the same name as your username.
- Go to github.com/new
- Set the repo name to your exact username
- Make it public and check "Add a README file"
- Click Create repository
Already have a profile README? Skip to step 2.
2Add your stats card
Edit the README.md in your profile repo and paste:
Want a different look? Add &theme=tokyonight or use the editor below to customise everything.
Try it out
Generate your embed, preview it, then copy a single line.
All Parameters
Everything you can pass as a URL query parameter.
Stats You Can Hide
Pass a comma-separated list of keys to the hide parameter:
?hide=stars,issues,followers
| Key | Stat |
|---|---|
stars | Total Stars Earned |
commits | Total Commits (year) |
prs | Pull Requests |
issues | Issues Opened |
streak | Current Streak |
week | Commits This Week |
trend | Weekly Trend (+/-) |
avg | Avg Commits Per Day |
active_day | Most Active Day |
grade | Activity Grade |
contributions | Contributions This Year |
repos | Public Repos |
followers | Followers |
Badge Styles
Pass style to /api/mini or /api/badge to switch the badge look.
?style=for-the-badge