Github Readme Streak Stats

Display your total contributions, current streak,
and longest streak on your GitHub profile README

⚡ Quick setup

Option 1: Web Deployment

1. Copy-paste the markdown below into your GitHub profile README
2. Replace the value after ?user= with your GitHub username

[![GitHub Streak](https://streak-stats.demolab.com/?user=DenverCoder1)](https://git.io/streak-stats)

Next Steps

• Check out the Demo Site or Options below for available customizations.

• It is recommended to self-host the project more better reliability. See Deploying it on your own for more details.

![][hspace] [][herokudeploy] [][verceldeploy]

Option 2: GitHub Actions

GitHub Actions can generate a static SVG in your profile repository so your README does not depend on the public hosted endpoint. If you need private contribution data, add a custom token to Repository Secrets using the steps below.

1. Create the workflow file

Create a folder in your repo named .github and within it a folder named workflows and add a file /.github/workflows/streak-stats.yml in your profile repo (USERNAME/USERNAME):

name: Update streak stats

on:
  schedule:
    - cron: "0 3 * * *" # Run every day at 03:00
  push:
    paths:
      - ".github/workflows/streak-stats.yml" # Run any time this file is modified
  workflow_dispatch: # Run manually from the Actions tab

jobs:
  build:
    runs-on: ubuntu-latest
    permissions:
      contents: write

    steps:
      - uses: actions/checkout@v7

      - name: Generate streak stats
        uses: DenverCoder1/github-readme-streak-stats@v1
        with:
          options: user=${{ github.repository_owner }}&theme=default&disable_animations=true
          path: profile/streak.svg

      - name: Commit streak stats
        run: |
          git config user.name "github-actions[bot]"
          git config user.email "github-actions[bot]@users.noreply.github.com"
          git add profile/streak.svg
          git commit -m "Update streak stats" || exit 0
          git push

2. Show the generated stats in your README

Add this to your profile README.md file where you want the stats to appear:

<a href="https://git.io/streak-stats"><img src="https://raw.githubusercontent.com/DenverCoder1/github-readme-streak-stats/HEAD/./profile/streak.svg" alt="GitHub Streak" /></a>

If you are using a fork, replace DenverCoder1 with the account or organization that hosts your fork.

For private contributions, you will need a Personal Access Token (PAT):

1. Create a Personal Access Token (PAT) with the repo scope.
2. Do not use the PAT directly in the workflow file; store it in the repository's GitHub Actions secrets (Settings > Secrets and variables > Actions -> New repository secret). Give it a descriptive name, such as STREAK_STATS_TOKEN.
3. Update your workflow file to use the token with the name you specified:

- name: Generate streak stats
  uses: DenverCoder1/github-readme-streak-stats@v1
  with:
    options: user=${{ github.repository_owner }}&theme=default&disable_animations=true
    path: profile/streak.svg
    token: ${{ secrets.STREAK_STATS_TOKEN }}

Next Steps

• Check out the Options below for available customizations.

⚙ Demo Site

Here you can customize your Streak Stats card with a live preview.

https://streak-stats.demolab.com

🔧 Options

The user field is the only required option. All other fields are optional.

If the theme parameter is specified, any color customizations specified will be applied on top of the theme, overriding the theme's values.