GitHub
Badges for GitHub repositories — stars, forks, releases, CI, issues, PRs, and more.
Display live stats from any public GitHub repository.
Stars (branded)
Release
CI status
License
Last commit
Forks (branded)
URL formats
All GitHub badges support both URL formats:
/github/{topic}/{owner}/{repo}.svg/github/{owner}/{repo}/{topic}.svgAvailable badges
| Category | Topics | Description |
|---|---|---|
| Stars | stars | Repository star count |
| Forks | forks | Repository fork count |
| License | license | Repository license |
| Release | release, releases, tags, tag, assets-dl | Releases, tags, and downloads |
| Downloads | downloads, downloads-all, downloads-asset | Granular release asset download counts |
| CI Status | ci, checks | GitHub Actions workflow status |
| Issues | issues, open-issues, closed-issues, label-issues | Issue counts by state or label |
| Pull Requests | prs, open-prs, closed-prs, merged-prs | PR counts by state |
| Commits | commits, last-commit | Commit count and recency |
| Repository | watchers, branches, contributors, dependabot, milestones | Other repo metadata |
| Sponsors | sponsors | Active GitHub Sponsors for a user or org |
Quick examples
Data source
All data from the GitHub REST API. Uses the token pool for distributed rate limiting. Most badges cached 1 hour, CI/checks cached 10 minutes.
Endpoint details
Use these sections when you need the exact URL shape or a focused example for a specific badge type.
GitHub CI Status
This section covers the github/ci badge endpoint.
Show the status of GitHub Actions workflows and commit checks.
GET/github/ci/:owner/:repo.svg
Path Parameters
required
required
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/ci/vercel/next.js.svg?mode=dark"><img alt="badge" src="https://shieldcn.dev/github/ci/vercel/next.js.svg?mode=light"></picture>
URL formats
Workflow status
/github/ci/{owner}/{repo}.svg/github/ci/{owner}/{repo}.svg?workflow=ci.yml/github/ci/{owner}/{repo}.svg?branch=main/github/ci/{owner}/{repo}.svg?workflow=ci.yml&branch=mainShows the conclusion of the most recent workflow run. Filter by workflow file or branch using query parameters.
Commit checks
/github/checks/{owner}/{repo}.svg/github/checks/{owner}/{repo}/{ref}.svg/github/checks/{owner}/{repo}/{ref}/{check_name}.svgShows the combined check status for a commit. Optionally specify a branch/tag ref or individual check name.
Status values
| Status | Color | Description |
|---|---|---|
passing | Green | All checks passed |
failing | Red | One or more checks failed |
pending | Amber | Checks are still running |
cancelled | Gray | Workflow was cancelled |
skipped | Gray | Workflow was skipped |
Copy-paste examples
Default — status dot shows pass/fail at a glance
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/ci/vercel/next.js.svg?mode=dark"><img alt="ci status" src="https://shieldcn.dev/github/ci/vercel/next.js.svg?mode=light"></picture>Secondary — softer CI badge for README rows
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/ci/vercel/next.js.svg?variant=secondary&mode=dark"><img alt="ci status" src="https://shieldcn.dev/github/ci/vercel/next.js.svg?variant=secondary&mode=light"></picture>Styling notes
CI badges automatically show a colored status dot based on the result. You can also use split mode for a two-tone background, or hide the dot entirely with ?statusDot=false.
Caching
CI badges are cached for 10 minutes to balance freshness with API rate limits.
GitHub Commits
This section covers the github/commits badge endpoint.
Show total commits or how recently a repository was updated.
GET/github/commits/:owner/:repo.svg
Path Parameters
required
required
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/commits/vercel/next.js.svg?mode=dark"><img alt="badge" src="https://shieldcn.dev/github/commits/vercel/next.js.svg?mode=light"></picture>
URL formats
Total commits
/github/commits/{owner}/{repo}.svg/github/commits/{owner}/{repo}/{branch}.svgShows the total number of commits. Optionally specify a branch.
Last commit
/github/last-commit/{owner}/{repo}.svg/github/last-commit/{owner}/{repo}/{branch}.svgShows relative time since the last commit (e.g., "2 hours ago", "3 days ago").
Copy-paste examples
Default — great maintenance signal for READMEs
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/last-commit/vercel/next.js.svg?mode=dark"><img alt="last commit" src="https://shieldcn.dev/github/last-commit/vercel/next.js.svg?mode=light"></picture>Secondary — total commit count showing project maturity
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/commits/vercel/next.js.svg?variant=secondary&mode=dark"><img alt="commits" src="https://shieldcn.dev/github/commits/vercel/next.js.svg?variant=secondary&mode=light"></picture>GitHub Downloads
This section covers the github/downloads badge endpoint.
Show download counts for release assets with granular control over scope.
GET/github/downloads/:owner/:repo.svg
Path Parameters
required
required
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/downloads/atom/atom.svg?mode=dark"><img alt="badge" src="https://shieldcn.dev/github/downloads/atom/atom.svg?mode=light"></picture>
URL formats
All assets, all releases
/github/downloads/{owner}/{repo}.svgTotal downloads across every asset in every release.
All assets, latest release
/github/downloads/{owner}/{repo}/latest.svgTotal downloads across all assets in the latest release only.
All assets, specific tag
/github/downloads/{owner}/{repo}/{tag}.svgTotal downloads across all assets for a specific release tag.
Specific asset, all releases
/github/downloads-asset/{owner}/{repo}/{assetName}.svgDownloads of a single asset file summed across all releases.
Specific asset, latest release
/github/downloads-asset/{owner}/{repo}/{assetName}/latest.svgDownloads of a single asset in the latest release only.
Specific asset, specific tag
/github/downloads-asset/{owner}/{repo}/{assetName}/{tag}.svgDownloads of a single asset in a specific release tag.
Examples
All assets, all releases
All assets, latest release
Branded variant
Specific asset
Copy-paste examples
Default — total downloads across all releases and assets
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/downloads/atom/atom.svg?mode=dark"><img alt="github downloads" src="https://shieldcn.dev/github/downloads/atom/atom.svg?mode=light"></picture>Branded — downloads for the latest release
Specific asset — downloads of atom-amd64.deb across all releases
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/downloads-asset/atom/atom/atom-amd64.deb.svg?mode=dark"><img alt="github asset downloads" src="https://shieldcn.dev/github/downloads-asset/atom/atom/atom-amd64.deb.svg?mode=light"></picture>Legacy endpoint
The older /github/assets-dl/{owner}/{repo} and /github/dt/{owner}/{repo} endpoints still work and return downloads for the latest release (or a specific tag). The new /github/downloads/ endpoints offer more flexibility.
GitHub Forks
This section covers the github/forks badge endpoint.
Show how many times a repository has been forked.
GET/github/forks/:owner/:repo.svg
Path Parameters
required
required
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/forks/vercel/next.js.svg?mode=dark"><img alt="badge" src="https://shieldcn.dev/github/forks/vercel/next.js.svg?mode=light"></picture>
URL format
/github/forks/{owner}/{repo}.svg/github/{owner}/{repo}/forks.svgCopy-paste examples
Default — pairs naturally with stars for project traction
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/forks/vercel/next.js.svg?mode=dark"><img alt="forks" src="https://shieldcn.dev/github/forks/vercel/next.js.svg?mode=light"></picture>Branded — GitHub brand color
GitHub Issues
This section covers the github/issues badge endpoint.
Issues (branded)
Open issues (default)
Open issues (outline)
Closed issues
Show open, closed, or labeled issue counts.
GET/github/issues/:owner/:repo.svg
Path Parameters
required
required
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/issues/vercel/next.js.svg?mode=dark"><img alt="badge" src="https://shieldcn.dev/github/issues/vercel/next.js.svg?mode=light"></picture>
URL formats
All open issues
/github/issues/{owner}/{repo}.svg/github/open-issues/{owner}/{repo}.svgClosed issues
/github/closed-issues/{owner}/{repo}.svgIssues by label
/github/label-issues/{owner}/{repo}/{label}.svg/github/label-issues/{owner}/{repo}/{label}/open.svg/github/label-issues/{owner}/{repo}/{label}/closed.svgFilter issues by GitHub label. URL-encode labels with spaces (e.g., help%20wanted).
Copy-paste examples
Outline — useful for contributor-facing repos
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/open-issues/vercel/next.js.svg?variant=outline&mode=dark"><img alt="open issues" src="https://shieldcn.dev/github/open-issues/vercel/next.js.svg?variant=outline&mode=light"></picture>Secondary — track resolved issue volume
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/closed-issues/vercel/next.js.svg?variant=secondary&mode=dark"><img alt="closed issues" src="https://shieldcn.dev/github/closed-issues/vercel/next.js.svg?variant=secondary&mode=light"></picture>GitHub License
This section covers the github/license badge endpoint.
Show which open source license a repository uses.
GET/github/license/:owner/:repo.svg
Path Parameters
required
required
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/license/vercel/next.js.svg?mode=dark"><img alt="badge" src="https://shieldcn.dev/github/license/vercel/next.js.svg?mode=light"></picture>
URL format
/github/license/{owner}/{repo}.svg/github/{owner}/{repo}/license.svgCopy-paste examples
Default — clean license badge for repo headers
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/license/vercel/next.js.svg?mode=dark"><img alt="license" src="https://shieldcn.dev/github/license/vercel/next.js.svg?mode=light"></picture>Ghost — subtle metadata badge for footer rows
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/license/vercel/next.js.svg?variant=ghost&mode=dark"><img alt="license" src="https://shieldcn.dev/github/license/vercel/next.js.svg?variant=ghost&mode=light"></picture>Response format
Shows the SPDX license identifier (e.g., MIT, Apache-2.0, GPL-3.0). If the repository has no detected license, shows none.
GitHub Pull Requests
This section covers the github/prs badge endpoint.
Show open, closed, or merged pull request counts.
GET/github/prs/:owner/:repo.svg
Path Parameters
required
required
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/prs/vercel/next.js.svg?mode=dark"><img alt="badge" src="https://shieldcn.dev/github/prs/vercel/next.js.svg?mode=light"></picture>
URL formats
Open PRs
/github/prs/{owner}/{repo}.svg/github/open-prs/{owner}/{repo}.svgClosed PRs
/github/closed-prs/{owner}/{repo}.svgMerged PRs
/github/merged-prs/{owner}/{repo}.svgCopy-paste examples
Outline — works well in contributor-facing repos
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/open-prs/vercel/next.js.svg?variant=outline&mode=dark"><img alt="open prs" src="https://shieldcn.dev/github/open-prs/vercel/next.js.svg?variant=outline&mode=light"></picture>Secondary — highlight merged contributions
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/merged-prs/vercel/next.js.svg?variant=secondary&mode=dark"><img alt="merged prs" src="https://shieldcn.dev/github/merged-prs/vercel/next.js.svg?variant=secondary&mode=light"></picture>GitHub Releases & Tags
This section covers the github/release badge endpoint.
Show release information, tags, and download counts.
GET/github/release/:owner/:repo.svg
Path Parameters
required
required
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/release/vercel/next.js.svg?mode=dark"><img alt="badge" src="https://shieldcn.dev/github/release/vercel/next.js.svg?mode=light"></picture>
URL formats
Latest release
/github/release/{owner}/{repo}.svgShows the latest release tag (including prereleases).
Stable release only
/github/release/{owner}/{repo}/stable.svgShows the latest non-prerelease version.
Release count
/github/releases/{owner}/{repo}.svgShows total number of releases.
Tag count
/github/tags/{owner}/{repo}.svgShows total number of tags.
Latest tag
/github/tag/{owner}/{repo}.svgShows the name of the most recent tag.
Asset downloads
/github/assets-dl/{owner}/{repo}.svg/github/assets-dl/{owner}/{repo}/{tag}.svgShows download count for release assets. Use a specific tag or omit for latest release.
Examples
Latest release (default)
Secondary variant
Branded variant
Outline variant
Copy-paste examples
Default — latest release version for product or OSS repos
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/release/vercel/next.js.svg?mode=dark"><img alt="release" src="https://shieldcn.dev/github/release/vercel/next.js.svg?mode=light"></picture>Branded — GitHub brand color
GitHub Repository
This section covers the github/repository badge endpoint.
Show various repository statistics and metadata.
GET/github/:topic/:owner/:repo.svg
Path Parameters
required
watchers, branches, contributors, dependabot, milestones
required
required
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/watchers/vercel/next.js.svg?mode=dark"><img alt="badge" src="https://shieldcn.dev/github/watchers/vercel/next.js.svg?mode=light"></picture>
URL formats
Watchers
/github/watchers/{owner}/{repo}.svgShows the number of people watching the repository.
Branches
/github/branches/{owner}/{repo}.svgShows the total number of branches.
Contributors
/github/contributors/{owner}/{repo}.svgShows the number of contributors.
Dependabot
/github/dependabot/{owner}/{repo}.svgShows whether Dependabot is enabled.
Milestones
/github/milestones/{owner}/{repo}/{number}.svgShows completion percentage for a specific milestone.
Examples
Watchers
Contributors
Branches (secondary)
Contributors (emerald)
Copy-paste examples
Default — contributor count for community sections
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/contributors/vercel/next.js.svg?mode=dark"><img alt="contributors" src="https://shieldcn.dev/github/contributors/vercel/next.js.svg?mode=light"></picture>Secondary — watcher count for social proof
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/watchers/vercel/next.js.svg?variant=secondary&mode=dark"><img alt="watchers" src="https://shieldcn.dev/github/watchers/vercel/next.js.svg?variant=secondary&mode=light"></picture>GitHub Sponsors
This section covers the github/sponsors badge endpoint.
Show how many people and organizations actively sponsor an account through GitHub Sponsors. Sponsors are account-scoped, so the badge takes a single username or organization — not a repository. It ships branded with the GitHub Sponsors heart and pink by default, so a bare URL drops straight into a README funding section.
GET/github/sponsors/:login.svg
Path Parameters
required
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/sponsors/jal-co.svg?mode=dark"><img alt="badge" src="https://shieldcn.dev/github/sponsors/jal-co.svg?mode=light"></picture>
URL format
/github/sponsors/{login}.svgThe count is the number of active sponsors (private sponsors are included in the total, never named). An account with GitHub Sponsors enabled but no sponsors shows 0.
Examples
Default — branded pink with the Sponsors heart
Outline
Extra small
Copy-paste examples
Default — active sponsor count for a README funding section
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/sponsors/jal-co.svg?mode=dark"><img alt="sponsors" src="https://shieldcn.dev/github/sponsors/jal-co.svg?mode=light"></picture>GitHub Stars
This section covers the github/stars badge endpoint.
Show how many stars a repository has earned.
GET/github/stars/:owner/:repo.svg
Path Parameters
required
required
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/stars/vercel/next.js.svg?mode=dark"><img alt="badge" src="https://shieldcn.dev/github/stars/vercel/next.js.svg?mode=light"></picture>
URL format
/github/stars/{owner}/{repo}.svg/github/{owner}/{repo}/stars.svgCopy-paste examples
Default — works great in any README
<picture><source media="(prefers-color-scheme: dark)" srcset="https://shieldcn.dev/github/stars/vercel/next.js.svg?mode=dark"><img alt="stars" src="https://shieldcn.dev/github/stars/vercel/next.js.svg?mode=light"></picture>Branded — GitHub's brand color
Response format
The badge shows the star count formatted with k/M suffixes for large numbers (e.g., 139.1k).