Pixel-perfect   Retina-ready   Fast   Consistent   Hackable   No tracking


Size

npm bundle size:npm bundle size badge/bundlephobia/:format/:packageName
npm bundle size (scoped):npm bundle size (scoped) badge/bundlephobia/:format/:scope/:packageName
npm bundle size (version):npm bundle size (version) badge/bundlephobia/:format/:packageName/:version
npm bundle size (scoped version):npm bundle size (scoped version) badge/bundlephobia/:format/:scope/:packageName/:version
Docker Image Size (latest by date):Docker Image Size (latest by date) badge/docker/image-size/:user/:repo?sort=date
Docker Image Size (latest semver):Docker Image Size (latest semver) badge/docker/image-size/:user/:repo?sort=semver
Docker Image Size (tag):Docker Image Size (tag) badge/docker/image-size/:user/:repo/:tag
GitHub code size in bytes:GitHub code size in bytes badge/github/languages/code-size/:user/:repo
GitHub repo file count:GitHub repo file count badge/github/directory-file-count/:user/:repo
GitHub repo file count (custom path):GitHub repo file count (custom path) badge/github/directory-file-count/:user/:repo/:path
GitHub repo directory count:GitHub repo directory count badge/github/directory-file-count/:user/:repo?type=dir
GitHub repo directory count (custom path):GitHub repo directory count (custom path) badge/github/directory-file-count/:user/:repo/:path?type=dir
GitHub repo file count (file type):GitHub repo file count (file type) badge/github/directory-file-count/:user/:repo?type=file
GitHub repo file count (custom path & file type):GitHub repo file count (custom path & file type) badge/github/directory-file-count/:user/:repo/:path?type=file
GitHub repo file count (file extension):GitHub repo file count (file extension) badge/github/directory-file-count/:user/:repo/:path?extension=js
GitHub repo size:GitHub repo size badge/github/repo-size/:user/:repo
GitHub file size in bytes:GitHub file size in bytes badge/github/size/:user/:repo/:path*
Spiget Download Size:Spiget Download Size badge/spiget/download-size/:resourceId
Steam File Size:Steam File Size badge/steam/size/:fileId
Lines of code:Lines of code badge/tokei/lines/:provider/:user/:repo
Visual Studio App Center Size:Visual Studio App Center Size badge/visual-studio-app-center/releases/size/:owner/:app/:token

Your Badge

Static

Using dash "-" separator

/badge/<LABEL>-<MESSAGE>-<COLOR>

Dashes --→- Dash
Underscores __→_ Underscore
_ or Space  →  Space

Using query string parameters

/static/v1?label=<LABEL>&message=<MESSAGE>&color=<COLOR>

Colors

brightgreengreenyellowgreenyelloworangeredbluelightgrey
successimportantcriticalinformationalinactive
bluevioletff69b49cf

Endpoint

/endpoint?url=<URL>&style<STYLE>

Create badges from your own JSON endpoint.

Dynamic

/badge/dynamic/json?url=<URL>&label=<LABEL>&query=<$.DATA.SUBDATA>&color=<COLOR>&prefix=<PREFIX>&suffix=<SUFFIX>

/badge/dynamic/xml?url=<URL>&label=<LABEL>&query=<//data/subdata>&color=<COLOR>&prefix=<PREFIX>&suffix=<SUFFIX>

/badge/dynamic/yaml?url=<URL>&label=<LABEL>&query=<$.DATA.SUBDATA>&color=<COLOR>&prefix=<PREFIX>&suffix=<SUFFIX>

Styles

The following styles are available. Flat is the default. Examples are shown with an optional logo:

?style=plastic&logo=appveyorplastic
?style=flat&logo=appveyorflat
?style=flat-square&logo=appveyorflat-square
?style=for-the-badge&logo=appveyorfor-the-badge
?style=social&logo=appveyorsocial

Here are a few other parameters you can use: (connecting several with "&" is possible)

?label=healthinessesOverride the default left-hand-side text (URL-Encoding needed for spaces or special characters!)
?logo=appveyorInsert one of the named logos from (bitcoin, dependabot, gitlab, npm, paypal, serverfault, stackexchange, superuser, telegram, travis) or simple-icons. Simple-icons are referenced using icon slugs which can be found on the simple-icons site or in the slugs.md file in the simple-icons repository.
?logo=data:image/png;base64,…Insert custom logo image (≥ 14px high). There is a limit on the total size of request headers we can accept (8192 bytes). From a practical perspective, this means the base64-encoded image text is limited to somewhere slightly under 8192 bytes depending on the rest of the request header.
?logoColor=violetSet the color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for named logos but not for custom logos.
?logoWidth=40Set the horizontal space to give to the logo
?link=http://left&link=http://rightSpecify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an<object> HTML tag, but not an<img> tag or a markup language.
?labelColor=abcdefSet background of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported). The legacy name "colorA" is also supported.
?color=fedcbaSet background of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported). The legacy name "colorB" is also supported.
?cacheSeconds=3600Set the HTTP cache lifetime (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored). The legacy name "maxAge" is also supported.

We support .svg and .json. The default is .svg, which can be omitted from the URL.

While we highly recommend using SVG, we also support .png for use cases where SVG will not work. These requests should be made to our raster server https://raster.shields.io. For example, the raster equivalent of https://img.shields.io/npm/v/express is https://raster.shields.io/npm/v/express. For backward compatibility, the badge server will redirect .png badges to the raster server.

Like This?

Have an idea for an awesome new badge?
Tell us about it and we might bring it to you!

CommunityStatusMetricsGitHub