GitHub — shieldcn

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}.svg

Available 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

Quick examples

![stars](https://shieldcn.dev/github/stars/vercel/next.js.svg)

![release](https://shieldcn.dev/github/release/vercel/next.js.svg)

![ci](https://shieldcn.dev/github/ci/vercel/next.js.svg)

![license](https://shieldcn.dev/github/license/vercel/next.js.svg)

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

ownerrequired

reporequired

workflow

branch

format

variant

size

theme

mode

logo

logoColor

label

flags

splitstatusDot

![badge](https://shieldcn.dev/github/ci/vercel/next.js.png)

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=main

Shows 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}.svg

Shows 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

![ci status](https://shieldcn.dev/github/ci/vercel/next.js.svg)

Secondary — softer CI badge for README rows

![ci status](https://shieldcn.dev/github/ci/vercel/next.js.svg?variant=secondary)

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

ownerrequired

reporequired

format

variant

size

theme

mode

logo

logoColor

label

flags

split

![badge](https://shieldcn.dev/github/commits/vercel/next.js.png)

URL formats

Total commits

/github/commits/{owner}/{repo}.svg

/github/commits/{owner}/{repo}/{branch}.svg

Shows the total number of commits. Optionally specify a branch.

Last commit

/github/last-commit/{owner}/{repo}.svg

/github/last-commit/{owner}/{repo}/{branch}.svg

Shows relative time since the last commit (e.g., "2 hours ago", "3 days ago").

Copy-paste examples

Default — great maintenance signal for READMEs

![last commit](https://shieldcn.dev/github/last-commit/vercel/next.js.svg)

Secondary — total commit count showing project maturity

![commits](https://shieldcn.dev/github/commits/vercel/next.js.svg?variant=secondary)

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

ownerrequired

reporequired

format

variant

size

theme

mode

logo

logoColor

label

flags

split

![badge](https://shieldcn.dev/github/downloads/atom/atom.png)

URL formats

All assets, all releases

/github/downloads/{owner}/{repo}.svg

Total downloads across every asset in every release.

All assets, latest release

/github/downloads/{owner}/{repo}/latest.svg

Total downloads across all assets in the latest release only.

All assets, specific tag

/github/downloads/{owner}/{repo}/{tag}.svg

Total downloads across all assets for a specific release tag.

Specific asset, all releases

/github/downloads-asset/{owner}/{repo}/{assetName}.svg

Downloads of a single asset file summed across all releases.

Specific asset, latest release

/github/downloads-asset/{owner}/{repo}/{assetName}/latest.svg

Downloads of a single asset in the latest release only.

Specific asset, specific tag

/github/downloads-asset/{owner}/{repo}/{assetName}/{tag}.svg

Downloads 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

![github downloads](https://shieldcn.dev/github/downloads/atom/atom.svg)

Branded — downloads for the latest release

![github downloads latest](https://shieldcn.dev/github/downloads/atom/atom/latest.svg?variant=branded)

Specific asset — downloads of atom-amd64.deb across all releases

![github asset downloads](https://shieldcn.dev/github/downloads-asset/atom/atom/atom-amd64.deb.svg)

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

ownerrequired

reporequired

format

variant

size

theme

mode

logo

logoColor

label

flags

split

![badge](https://shieldcn.dev/github/forks/vercel/next.js.png)

URL format

/github/forks/{owner}/{repo}.svg

/github/{owner}/{repo}/forks.svg

Copy-paste examples

Default — pairs naturally with stars for project traction

![forks](https://shieldcn.dev/github/forks/vercel/next.js.svg)

Branded — GitHub brand color

![forks](https://shieldcn.dev/github/forks/vercel/next.js.svg?variant=branded)

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

ownerrequired

reporequired

format

variant

size

theme

mode

logo

logoColor

label

flags

split

![badge](https://shieldcn.dev/github/issues/vercel/next.js.png)

URL formats

All open issues

/github/issues/{owner}/{repo}.svg

/github/open-issues/{owner}/{repo}.svg

Closed issues

/github/closed-issues/{owner}/{repo}.svg

Issues by label

/github/label-issues/{owner}/{repo}/{label}.svg

/github/label-issues/{owner}/{repo}/{label}/open.svg

/github/label-issues/{owner}/{repo}/{label}/closed.svg

Filter issues by GitHub label. URL-encode labels with spaces (e.g., help%20wanted).

Copy-paste examples

Outline — useful for contributor-facing repos

![open issues](https://shieldcn.dev/github/open-issues/vercel/next.js.svg?variant=outline)

Secondary — track resolved issue volume

![closed issues](https://shieldcn.dev/github/closed-issues/vercel/next.js.svg?variant=secondary)

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

ownerrequired

reporequired

format

variant

size

theme

mode

logo

logoColor

label

flags

split

![badge](https://shieldcn.dev/github/license/vercel/next.js.png)

URL format

/github/license/{owner}/{repo}.svg

/github/{owner}/{repo}/license.svg

Copy-paste examples

Default — clean license badge for repo headers

![license](https://shieldcn.dev/github/license/vercel/next.js.svg)

Ghost — subtle metadata badge for footer rows

![license](https://shieldcn.dev/github/license/vercel/next.js.svg?variant=ghost)

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

ownerrequired

reporequired

format

variant

size

theme

mode

logo

logoColor

label

flags

split

![badge](https://shieldcn.dev/github/prs/vercel/next.js.png)

URL formats

Open PRs

/github/prs/{owner}/{repo}.svg

/github/open-prs/{owner}/{repo}.svg

Closed PRs

/github/closed-prs/{owner}/{repo}.svg

Merged PRs

/github/merged-prs/{owner}/{repo}.svg

Copy-paste examples

Outline — works well in contributor-facing repos

![open prs](https://shieldcn.dev/github/open-prs/vercel/next.js.svg?variant=outline)

Secondary — highlight merged contributions

![merged prs](https://shieldcn.dev/github/merged-prs/vercel/next.js.svg?variant=secondary)

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

ownerrequired

reporequired

format

variant

size

theme

mode

logo

logoColor

label

flags

split

![badge](https://shieldcn.dev/github/release/vercel/next.js.png)

URL formats

Latest release

/github/release/{owner}/{repo}.svg

Shows the latest release tag (including prereleases).

Stable release only

/github/release/{owner}/{repo}/stable.svg

Shows the latest non-prerelease version.

Release count

/github/releases/{owner}/{repo}.svg

Shows total number of releases.

Tag count

/github/tags/{owner}/{repo}.svg

Shows total number of tags.

Latest tag

/github/tag/{owner}/{repo}.svg

Shows the name of the most recent tag.

Asset downloads

/github/assets-dl/{owner}/{repo}.svg

/github/assets-dl/{owner}/{repo}/{tag}.svg

Shows 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

![release](https://shieldcn.dev/github/release/vercel/next.js.svg)

Branded — GitHub brand color

![release](https://shieldcn.dev/github/release/vercel/next.js.svg?variant=branded)

GitHub Repository

This section covers the github/repository badge endpoint.

Show various repository statistics and metadata.

GET/github/:topic/:owner/:repo.svg

Path Parameters

topicrequired

watchers, branches, contributors, dependabot, milestones

ownerrequired

reporequired

format

variant

size

theme

mode

logo

logoColor

label

flags

split

![badge](https://shieldcn.dev/github/watchers/vercel/next.js.png)

URL formats

Watchers

/github/watchers/{owner}/{repo}.svg

Shows the number of people watching the repository.

Branches

/github/branches/{owner}/{repo}.svg

Shows the total number of branches.

Contributors

/github/contributors/{owner}/{repo}.svg

Shows the number of contributors.

Dependabot

/github/dependabot/{owner}/{repo}.svg

Shows whether Dependabot is enabled.

Milestones

/github/milestones/{owner}/{repo}/{number}.svg

Shows completion percentage for a specific milestone.

Examples

Watchers

Contributors

Branches (secondary)

Contributors (emerald)

Copy-paste examples

Default — contributor count for community sections

![contributors](https://shieldcn.dev/github/contributors/vercel/next.js.svg)

Secondary — watcher count for social proof

![watchers](https://shieldcn.dev/github/watchers/vercel/next.js.svg?variant=secondary)

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

ownerrequired

reporequired

format

variant

size

theme

mode

logo

logoColor

label

flags

split

![badge](https://shieldcn.dev/github/stars/vercel/next.js.png)

URL format

/github/stars/{owner}/{repo}.svg

/github/{owner}/{repo}/stars.svg

Copy-paste examples

Default — works great in any README

![stars](https://shieldcn.dev/github/stars/vercel/next.js.svg)

Branded — GitHub's brand color

![stars](https://shieldcn.dev/github/stars/vercel/next.js.svg?variant=branded&logo=github)

Response format

The badge shows the star count formatted with k/M suffixes for large numbers (e.g., 139.1k).