be-next/GitHub Streak Stats
Generate streak stats SVG for your GitHub profile README
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| username | GitHub username to generate stats for | yes | — |
| token | GitHub token for API access | yes | — |
| output-path | Path to save the generated SVG | no | streak-stats.svg |
| theme | Theme for the SVG (default, dark) | no | default |
| timezone | IANA timezone used to resolve "today" and "yesterday" for the current streak (e.g. Europe/Paris, America/New_York). Defaults to UTC. | no | UTC |
| hide-border | Hide the border around the card | no | false |
| background | Custom background color (hex without #) | no | "" |
| stroke | Custom border color (hex without #) | no | "" |
| ring | Custom ring color (hex without #) | no | "" |
| fire | Custom fire/streak color (hex without #) | no | "" |
| currStreakNum | Custom current streak number color (hex without #) | no | "" |
| sideNums | Custom side numbers color (hex without #) | no | "" |
| currStreakLabel | Custom current streak label color (hex without #) | no | "" |
| sideLabels | Custom side labels color (hex without #) | no | "" |
| dates | Custom dates color (hex without #) | no | "" |
Outputs
| name | description |
|---|---|
| total-contributions | Total contributions count |
| current-streak | Current streak in days |
| current-streak-start | Start date of the current streak (YYYY-MM-DD), empty if no active streak |
| current-streak-end | End date of the current streak (YYYY-MM-DD), empty if no active streak |
| longest-streak | Longest streak in days |
| longest-streak-start | Start date of the longest streak (YYYY-MM-DD), empty if zero |
| longest-streak-end | End date of the longest streak (YYYY-MM-DD), empty if zero |