GitHub Readme Stats

Get dynamically generated GitHub stats on your READMEs!

View Demo · Report Bug · Request Feature · FAQ · Ask Question

Love the project? Please consider donating to help it improve!

` element in combination with the `prefers-color-scheme` media feature. ```html ```

:eyes: Show example

### Customization You can customize the appearance of all your cards however you wish with URL parameters. #### Common Options | Name | Description | Type | Default value | | --- | --- | --- | --- | | `title_color` | Card's title color. | string (hex color) | `2f80ed` | | `text_color` | Body text color. | string (hex color) | `434d58` | | `icon_color` | Icons color if available. | string (hex color) | `4c71f2` | | `border_color` | Card's border color. Does not apply when `hide_border` is enabled. | string (hex color) | `e4e2e2` | | `bg_color` | Card's background color. | string (hex color or a gradient in the form of *angle,start,end*) | `fffefe` | | `hide_border` | Hides the card's border. | boolean | `false` | | `theme` | Name of the theme, choose from [all available themes](themes/README.md). | enum | `default` | | `cache_seconds` | Sets the cache header manually (min: 21600, max: 86400). | integer | `21600` | | `locale` | Sets the language in the card, you can check full list of available locales [here](#available-locales). | enum | `en` | | `border_radius` | Corner rounding on the card. | number | `4.5` | > [!WARNING]\ > We use caching to decrease the load on our servers (see ). Our cards have the following default cache hours: stats card - 24 hours, top languages card - 144 hours (6 days), pin card - 240 hours (10 days), gist card - 48 hours (2 days). If you want the data on your statistics card to be updated more often you can [deploy your own instance](#deploy-on-your-own) and set [environment variable](#available-environment-variables) `CACHE_SECONDS` to a value of your choosing. ##### Gradient in bg\_color You can provide multiple comma-separated values in the bg\_color option to render a gradient with the following format: &bg_color=DEG,COLOR1,COLOR2,COLOR3...COLOR10 ##### Available locales Here is a list of all available locales:

| Code | Locale | | --- | --- | | `ar` | Arabic | | `az` | Azerbaijani | | `bn` | Bengali | | `bg` | Bulgarian | | `my` | Burmese | | `ca` | Catalan | | `cn` | Chinese | | `zh-tw` | Chinese (Taiwan) | | `cs` | Czech | | `nl` | Dutch | | `en` | English | | `fil` | Filipino | | `fi` | Finnish | | `fr` | French | | `de` | German | | `el` | Greek |

| Code | Locale | | --- | --- | | `he` | Hebrew | | `hi` | Hindi | | `hu` | Hungarian | | `id` | Indonesian | | `it` | Italian | | `ja` | Japanese | | `kr` | Korean | | `ml` | Malayalam | | `np` | Nepali | | `no` | Norwegian | | `fa` | Persian (Farsi) | | `pl` | Polish | | `pt-br` | Portuguese (Brazil) | | `pt-pt` | Portuguese (Portugal) | | `ro` | Romanian |

| Code | Locale | | --- | --- | | `ru` | Russian | | `sa` | Sanskrit | | `sr` | Serbian (Cyrillic) | | `sr-latn` | Serbian (Latin) | | `sk` | Slovak | | `es` | Spanish | | `sw` | Swahili | | `se` | Swedish | | `ta` | Tamil | | `th` | Thai | | `tr` | Turkish | | `uk-ua` | Ukrainian | | `ur` | Urdu | | `uz` | Uzbek | | `vi` | Vietnamese |

If we don't support your language, please consider contributing! You can find more information about how to do it in our [contributing guidelines](CONTRIBUTING.md#translations-contribution). #### Stats Card Exclusive Options | Name | Description | Type | Default value | | --- | --- | --- | --- | | `hide` | Hides the [specified items](#hiding-individual-stats) from stats. | string (comma-separated values) | `null` | | `hide_title` | Hides the title of your stats card. | boolean | `false` | | `card_width` | Sets the card's width manually. | number | `500px (approx.)` | | `hide_rank` | Hides the rank and automatically resizes the card width. | boolean | `false` | | `rank_icon` | Shows alternative rank icon (i.e. `github`, `percentile` or `default`). | enum | `default` | | `show_icons` | Shows icons near all stats. | boolean | `false` | | `include_all_commits` | Count total commits instead of just the current year commits. | boolean | `false` | | `line_height` | Sets the line height between text. | integer | `25` | | `exclude_repo` | Excludes specified repositories. | string (comma-separated values) | `null` | | `custom_title` | Sets a custom title for the card. | string | ` GitHub Stats` | | `text_bold` | Uses bold text. | boolean | `true` | | `disable_animations` | Disables all animations in the card. | boolean | `false` | | `ring_color` | Color of the rank circle. | string (hex color) | `2f80ed` | | `number_format` | Switches between two available formats for displaying the card values `short` (i.e. `6.6k`) and `long` (i.e. `6626`). | enum | `short` | | `show` | Shows [additional items](#showing-additional-individual-stats) on stats card (i.e. `reviews`, `discussions_started`, `discussions_answered`, `prs_merged` or `prs_merged_percentage`). | string (comma-separated values) | `null` | | `commits_year` | Filters and counts only commits made in the specified year. | integer _(YYYY)_ | ` (one year to date)` | > [!NOTE]\ > When hide\_rank=`true`, the minimum card width is 270 px + the title length and padding. *** # GitHub Extra Pins GitHub extra pins allow you to pin more than 6 repositories in your profile using a GitHub readme profile. Yay! You are no longer limited to 6 pinned repositories. ### Usage Copy-paste this code into your readme and change the links. Endpoint: `api/pin?username=anuraghazra&repo=github-readme-stats` ```md [](https://github.com/anuraghazra/github-readme-stats) ``` ### Options You can customize the appearance and behavior of the pinned repository card using the [common options](#common-options) and exclusive options listed in the table below. | Name | Description | Type | Default value | | --- | --- | --- | --- | | `show_owner` | Shows the repo's owner name. | boolean | `false` | | `description_lines_count` | Manually set the number of lines for the description. Specified value will be clamped between 1 and 3. If this parameter is not specified, the number of lines will be automatically adjusted according to the actual length of the description. | number | `null` | ### Demo  Use `show_owner` query option to include the repo's owner username  # GitHub Gist Pins GitHub gist pins allow you to pin gists in your GitHub profile using a GitHub readme profile. ### Usage Copy-paste this code into your readme and change the links. Endpoint: `api/gist?id=bbfce31e0217a3689c8d961a356cb10d` ```md [](https://gist.github.com/Yizack/bbfce31e0217a3689c8d961a356cb10d/) ``` ### Options You can customize the appearance and behavior of the gist card using the [common options](#common-options) and exclusive options listed in the table below. | Name | Description | Type | Default value | | --- | --- | --- | --- | | `show_owner` | Shows the gist's owner name. | boolean | `false` | ### Demo  Use `show_owner` query option to include the gist's owner username  # Top Languages Card The top languages card shows a GitHub user's most frequently used languages. > [!WARNING]\ > By default, the language card shows language results only from public repositories. To include languages used in private repositories, you should [deploy your own instance](#deploy-on-your-own) using your own GitHub API token. > [!NOTE]\ > Top Languages does not indicate the user's skill level or anything like that; it's a GitHub metric to determine which languages have the most code on GitHub. It is a new feature of github-readme-stats. > [!WARNING]\ > This card shows language usage only inside your own non-forked repositories, not depending on who the author of the commits is. It does not include your contributions into another users/organizations repositories. Currently there are no way to get this data from GitHub API. If you want this behavior to be improved you can support [this feature request](https://github.com/orgs/community/discussions/18230) created by [@rickstaa](https://github.com/rickstaa) inside GitHub Community. > [!WARNING]\ > Currently this card shows data only about first 100 repositories. This is because GitHub API limitations which cause downtimes of public instances (see [#1471](https://github.com/anuraghazra/github-readme-stats/issues/1471)). In future this behavior will be improved by releasing GitHub action or providing environment variables for user's own instances. ### Usage Copy-paste this code into your readme and change the links. Endpoint: `api/top-langs?username=anuraghazra` ```md [](https://github.com/anuraghazra/github-readme-stats) ``` ### Options You can customize the appearance and behavior of the top languages card using the [common options](#common-options) and exclusive options listed in the table below. | Name | Description | Type | Default value | | --- | --- | --- | --- | | `hide` | Hides the [specified languages](#hide-individual-languages) from card. | string (comma-separated values) | `null` | | `hide_title` | Hides the title of your card. | boolean | `false` | | `layout` | Switches between five available layouts `normal` & `compact` & `donut` & `donut-vertical` & `pie`. | enum | `normal` | | `card_width` | Sets the card's width manually. | number | `300` | | `langs_count` | Shows more languages on the card, between 1-20. | integer | `5` for `normal` and `donut`, `6` for other layouts | | `exclude_repo` | Excludes specified repositories. | string (comma-separated values) | `null` | | `custom_title` | Sets a custom title for the card. | string | `Most Used Languages` | | `disable_animations` | Disables all animations in the card. | boolean | `false` | | `hide_progress` | Uses the compact layout option, hides percentages, and removes the bars. | boolean | `false` | | `size_weight` | Configures language stats algorithm (see [Language stats algorithm](#language-stats-algorithm)). | integer | `1` | | `count_weight` | Configures language stats algorithm (see [Language stats algorithm](#language-stats-algorithm)). | integer | `0` | | `stats_format` | Switches between two available formats for language's stats `percentages` and `bytes`. | enum | `percentages` | > [!WARNING]\ > Language names should be URI-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding) > (i.e: `c++` should become `c%2B%2B`, `jupyter notebook` should become `jupyter%20notebook`, etc.) You can use > [urlencoder.org](https://www.urlencoder.org/) to help you do this automatically. ### Language stats algorithm We use the following algorithm to calculate the languages percentages on the language card: ```js ranking_index = (byte_count ^ size_weight) * (repo_count ^ count_weight) ``` By default, only the byte count is used for determining the languages percentages shown on the language card (i.e. `size_weight=1` and `count_weight=0`). You can, however, use the `&size_weight=` and `&count_weight=` options to weight the language usage calculation. The values must be positive real numbers. [More details about the algorithm can be found here](https://github.com/anuraghazra/github-readme-stats/issues/1600#issuecomment-1046056305). * `&size_weight=1&count_weight=0` - *(default)* Orders by byte count. * `&size_weight=0.5&count_weight=0.5` - *(recommended)* Uses both byte and repo count for ranking * `&size_weight=0&count_weight=1` - Orders by repo count ```md  ``` ### Exclude individual repositories You can use the `&exclude_repo=repo1,repo2` parameter to exclude individual repositories. ```md  ``` ### Hide individual languages You can use `&hide=language1,language2` parameter to hide individual languages. ```md  ``` ### Show more languages You can use the `&langs_count=` option to increase or decrease the number of languages shown on the card. Valid values are integers between 1 and 20 (inclusive). By default it was set to `5` for `normal` & `donut` and `6` for other layouts. ```md  ``` ### Compact Language Card Layout You can use the `&layout=compact` option to change the card design. ```md  ``` ### Donut Chart Language Card Layout You can use the `&layout=donut` option to change the card design. ```md [](https://github.com/anuraghazra/github-readme-stats) ``` ### Donut Vertical Chart Language Card Layout You can use the `&layout=donut-vertical` option to change the card design. ```md [](https://github.com/anuraghazra/github-readme-stats) ``` ### Pie Chart Language Card Layout You can use the `&layout=pie` option to change the card design. ```md [](https://github.com/anuraghazra/github-readme-stats) ``` ### Hide Progress Bars You can use the `&hide_progress=true` option to hide the percentages and the progress bars (layout will be automatically set to `compact`). ```md  ``` ### Change format of language's stats You can use the `&stats_format=bytes` option to display the stats in bytes instead of percentage. ```md  ``` ### Demo  * Compact layout  * Donut Chart layout [](https://github.com/anuraghazra/github-readme-stats) * Donut Vertical Chart layout [](https://github.com/anuraghazra/github-readme-stats) * Pie Chart layout [](https://github.com/anuraghazra/github-readme-stats) * Hidden progress bars  * Display bytes instead of percentage  # WakaTime Stats Card > [!WARNING]\ > Please be aware that we currently only show data from WakaTime profiles that are public. You therefore have to make sure that **BOTH** `Display code time publicly` and `Display languages, editors, os, categories publicly` are enabled. > [!WARNING]\ > In case you just created a new WakaTime account, then it might take up to 24 hours until your stats will become visible on the WakaTime stats card. Change the `?username=` value to your [WakaTime](https://wakatime.com) username. ```md [](https://github.com/anuraghazra/github-readme-stats) ``` ### Options You can customize the appearance and behavior of the WakaTime stats card using the [common options](#common-options) and exclusive options listed in the table below. | Name | Description | Type | Default value | | --- | --- | --- | --- | | `hide` | Hides the languages specified from the card. | string (comma-separated values) | `null` | | `hide_title` | Hides the title of your card. | boolean | `false` | | `card_width` | Sets the card's width manually. | number | `495` | | `line_height` | Sets the line height between text. | integer | `25` | | `hide_progress` | Hides the progress bar and percentage. | boolean | `false` | | `custom_title` | Sets a custom title for the card. | string | `WakaTime Stats` | | `layout` | Switches between two available layouts `default` & `compact`. | enum | `default` | | `langs_count` | Limits the number of languages on the card, defaults to all reported languages. | integer | `null` | | `api_domain` | Sets a custom API domain for the card, e.g. to use services like [Hakatime](https://github.com/mujx/hakatime) or [Wakapi](https://github.com/muety/wakapi) | string | `wakatime.com` | | `display_format` | Sets the WakaTime stats display format. Choose `time` to display time-based stats or `percent` to show percentages. | enum | `time` | | `disable_animations` | Disables all animations in the card. | boolean | `false` | ### Demo   * Compact layout  *** # All Demos * Default  * Hiding specific stats  * Showing additional stats  * Showing icons  * Shows GitHub logo instead rank level  * Shows user rank percentile instead of rank level  * Customize Border Color  * Include All Commits  * Themes Choose from any of the [default themes](#themes)  * Gradient  * Customizing stats card  * Setting card locale  * Customizing repo card  * Gist card  * Customizing gist card  * Top languages  * WakaTime card  *** ## Quick Tip (Align The Cards) By default, GitHub does not lay out the cards side by side. To do that, you can use such approaches: ### Stats and top languages cards ```html ```

:eyes: Show example

### Pinning repositories ```html ```

:eyes: Show example

# Deploy on your own ## First step: get your Personal Access Token (PAT) For deploying your own instance of GitHub Readme Stats, you will need to create a GitHub Personal Access Token (PAT). Below are the steps to create one and the scopes you need to select for both classic and fine-grained tokens. Selecting the right scopes for your token is important in case you want to display private contributions on your cards. ### Classic token - Go to [Account -> Settings -> Developer Settings -> Personal access tokens -> Tokens (classic)](https://github.com/settings/tokens). - Click on `Generate new token -> Generate new token (classic)`. - Scopes to select: - repo - read:user - Click on `Generate token` and copy it. ### Fine-grained token > [!WARNING]\ > This limits the number of issues to the number of issues on your repositories only and only takes public commits into account. - Go to [Account -> Settings -> Developer Settings -> Personal access tokens -> Fine-grained tokens](https://github.com/settings/tokens). - Click on `Generate new token -> Generate new token`. - Select an expiration date - Select `All repositories` - Scopes to select in `Repository permission`: - Commit statuses: read-only - Contents: read-only - Issues: read-only - Metadata: read-only - Pull requests: read-only - Click on `Generate token` and copy it. ## On Vercel ### :film\_projector: [Check Out Step By Step Video Tutorial By @codeSTACKr](https://youtu.be/n6d4KHSKqGk?t=107) Since the GitHub API only allows 5k requests per hour, my `https://github-readme-stats.vercel.app/api` could possibly hit the rate limiter. If you host it on your own Vercel server, then you do not have to worry about anything. Click on the deploy button to get started! > [!NOTE]\ > Since [#58](https://github.com/anuraghazra/github-readme-stats/pull/58), we should be able to handle more than 5k requests and have fewer issues with downtime :grin:. > [!NOTE]\ > If you are on the [Pro (i.e. paid)](https://vercel.com/pricing) Vercel plan, the [maxDuration](https://vercel.com/docs/concepts/projects/project-configuration#value-definition) value found in the [vercel.json](https://github.com/anuraghazra/github-readme-stats/blob/master/vercel.json) can be increased when your Vercel instance frequently times out during the card request. You are advised to keep this value lower than `30` seconds to prevent high memory usage. [](https://vercel.com/import/project?template=https://github.com/anuraghazra/github-readme-stats)

:hammer_and_wrench: Step-by-step guide on setting up your own Vercel instance

1. Go to [vercel.com](https://vercel.com/). 2. Click on `Log in`.  3. Sign in with GitHub by pressing `Continue with GitHub`.  4. Sign in to GitHub and allow access to all repositories if prompted. 5. Fork this repo. 6. Go back to your [Vercel dashboard](https://vercel.com/dashboard). 7. To import a project, click the `Add New...` button and select the `Project` option.  8. Click the `Continue with GitHub` button, search for the required Git Repository and import it by clicking the `Import` button. Alternatively, you can import a Third-Party Git Repository using the `Import Third-Party Git Repository ->` link at the bottom of the page.  9. Create a Personal Access Token (PAT) as described in the [previous section](#first-step-get-your-personal-access-token-pat). 10. Add the PAT as an environment variable named `PAT_1` (as shown).  11. Click deploy, and you're good to go. See your domains to use the API!

## On other platforms > [!WARNING]\ > This way of using GRS is not officially supported and was added to cater to some particular use cases where Vercel could not be used (e.g. [#2341](https://github.com/anuraghazra/github-readme-stats/discussions/2341)). The support for this method, therefore, is limited.

:hammer_and_wrench: Step-by-step guide for deploying on other platforms

1. Fork or clone this repo as per your needs 2. Move `express` from the devDependencies to the dependencies section of `package.json` 3. Run `npm i` if needed (initial setup) 4. Run `node express.js` to start the server, or set the entry point to `express.js` in `package.json` if you're deploying on a managed service 5. You're done 🎉

## Available environment variables GitHub Readme Stats provides several environment variables that can be used to customize the behavior of your self-hosted instance. These include: * `CACHE_SECONDS`: This takes precedence over our cache minimum and maximum values and can circumvent these values for self-hosted instances. * `WHITELIST`: A comma-separated list of GitHub usernames that are allowed to access your instance. If this variable is not set, all usernames are allowed. * `GIST_WHITELIST`: A comma-separated list of GitHub gist IDs that are allowed to be accessed on your instance. If this variable is not set, all gist IDs are allowed. * `EXCLUDE_REPO`: A comma-separated list of repositories that will be excluded from stats and top languages cards on your instance. This allows repository exclusion without exposing repository names in public URLs. This enhances privacy for self-hosted instances that include private repositories in stats cards. See [the Vercel documentation](https://vercel.com/docs/concepts/projects/environment-variables) on adding these environment variables to your Vercel instance. ## Keep your fork up to date You can keep your fork, and thus your private Vercel instance up to date with the upstream using GitHub's [Sync Fork button](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork). You can also use the [pull](https://github.com/wei/pull) package created by [@wei](https://github.com/wei) to automate this process. # :sparkling\_heart: Support the project I open-source almost everything I can and try to reply to everyone needing help using these projects. Obviously, this takes time. You can use this service for free. However, if you are using this project and are happy with it or just want to encourage me to continue creating stuff, there are a few ways you can do it: * Giving proper credit when you use github-readme-stats on your readme, linking back to it. :D * Starring and sharing the project. :rocket: * [](https://www.paypal.me/anuraghazra) - You can make a one-time donation via PayPal. I'll probably buy a ~~coffee~~ tea. :tea: Thanks! :heart: *** [](https://vercel.com?utm_source=github_readme_stats_team\&utm_campaign=oss) Contributions are welcome! <3 Made with :heart: and JavaScript.