Pixel-perfect   Retina-ready   Fast   Consistent   Hackable   No tracking

Build

AppVeyor:AppVeyor badge/appveyor/build/:user/:repo
AppVeyor branch:AppVeyor branch badge/appveyor/build/:user/:repo/:branch
AppVeyor Job:AppVeyor Job badge/appveyor/job/build/:user/:repo/:job
AppVeyor Job branch:AppVeyor Job branch badge/appveyor/job/build/:user/:repo/:job/:branch
Azure DevOps builds:Azure DevOps builds badge/azure-devops/build/:organization/:projectId/:definitionId
Azure DevOps builds (branch):Azure DevOps builds (branch) badge/azure-devops/build/:organization/:projectId/:definitionId/:branch
Azure DevOps builds (stage):Azure DevOps builds (stage) badge/azure-devops/build/:organization/:projectId/:definitionId/:branch*?stage=Successful%20Stage
Azure DevOps builds (job):Azure DevOps builds (job) badge/azure-devops/build/:organization/:projectId/:definitionId/:branch*?job=Successful%20Job&stage=Successful%20Stage
Azure DevOps releases:Azure DevOps releases badge/azure-devops/release/:organization/:projectId/:definitionId/:environmentId
Bitbucket Pipelines:Bitbucket Pipelines badge/bitbucket/pipelines/:user/:repo/:branch+
Bitrise:Bitrise badge/bitrise/:appId/:branch??token=lESRN9rEFFfDq92JtXs_jw
Buildkite:Buildkite badge/buildkite/:identifier
Buildkite (branch):Buildkite (branch) badge/buildkite/:identifier/:branch
CircleCI:CircleCI badge/circleci/build/:vcsType/:user/:repo/:branch*?token=abc123def456
Cirrus CI - Base Branch Build Status:Cirrus CI - Base Branch Build Status badge/cirrus/github/:user/:repo
Cirrus CI - Specific Branch Build Status:Cirrus CI - Specific Branch Build Status badge/cirrus/github/:user/:repo/:branch
Cirrus CI - Specific Task Build Status:Cirrus CI - Specific Task Build Status badge/cirrus/github/:user/:repo?task=build_docker
Cirrus CI - Task and Script Build Status:Cirrus CI - Task and Script Build Status badge/cirrus/github/:user/:repo?script=test&task=build_docker
Codeship:Codeship badge/codeship/:projectId
Codeship (branch):Codeship (branch) badge/codeship/:projectId/:branch
Docker Automated build:Docker Automated build badge/docker/automated/:user/:repo
Docker Cloud Automated build:Docker Cloud Automated build badge/docker/cloud/automated/:user/:repo
Docker Cloud Build Status:Docker Cloud Build Status badge/docker/cloud/build/:user/:repo
docs.rs:docs.rs badge/docsrs/:crate/:version?
Drone (cloud):Drone (cloud) badge/drone/build/:user/:repo
Drone (cloud) with branch:Drone (cloud) with branch badge/drone/build/:user/:repo/:branch
Drone (self-hosted):Drone (self-hosted) badge/drone/build/:user/:repo?server=https%3A%2F%2Fdrone.shields.io
Drone (self-hosted) with branch:Drone (self-hosted) with branch badge/drone/build/:user/:repo/:branch?server=https%3A%2F%2Fdrone.shields.io
GitHub Workflow Status:GitHub Workflow Status badge/github/actions/workflow/status/:user/:repo/:workflow+
GitHub Workflow Status (with branch):GitHub Workflow Status (with branch) badge/github/actions/workflow/status/:user/:repo/:workflow+?branch=main
GitHub Workflow Status (with event):GitHub Workflow Status (with event) badge/github/actions/workflow/status/:user/:repo/:workflow+?event=push
GitHub branch checks state:GitHub branch checks state badge/github/checks-status/:user/:repo/:ref
GitHub commit checks state:GitHub commit checks state badge/github/checks-status/:user/:repo/:ref
GitHub tag checks state:GitHub tag checks state badge/github/checks-status/:user/:repo/:ref
GitHub pull request check state:GitHub pull request check state badge/github/status/s/pulls/:user/:repo/:number
GitHub pull request check contexts:GitHub pull request check contexts badge/github/status/contexts/pulls/:user/:repo/:number
Gitlab pipeline status:Gitlab pipeline status badge/gitlab/pipeline-status/:project+?branch=master
Gitlab pipeline status (self-managed):Gitlab pipeline status (self-managed) badge/gitlab/pipeline-status/:project+?branch=master&gitlab_url=https%3A%2F%2Fgitlab.gnome.org
Jenkins:Jenkins badge/jenkins/build?jobUrl=https%3A%2F%2Fwso2.org%2Fjenkins%2Fview%2FAll%2520Builds%2Fjob%2Farchetypes
Netlify:Netlify badge/netlify/:projectId
OBS package build status:OBS package build status badge/obs/:project/:packageName/:repository/:arch?instance=https%3A%2F%2Fapi.opensuse.org
Read the Docs:Read the Docs badge/readthedocs/:packageName
Read the Docs (version):Read the Docs (version) badge/readthedocs/:packageName/:version
Scrutinizer build (GitHub/Bitbucket):Scrutinizer build (GitHub/Bitbucket) badge/scrutinizer/build/:vcs/:user/:repo/:branch?
Scrutinizer build (GitLab):Scrutinizer build (GitLab) badge/scrutinizer/build/gl/:instance/:user/:repo/:branch?
Sonar Test Count:Sonar Test Count badge/sonar/:metric/:component/:branch*?server=http%3A%2F%2Fsonar.petalslink.com&sonarVersion=4.2
Sonar Test Execution Time:Sonar Test Execution Time badge/sonar/test_execution_time/:component/:branch*?server=https%3A%2F%2Fsonarcloud.io&sonarVersion=4.2
Sonar Test Success Rate:Sonar Test Success Rate badge/sonar/test_success_density/:component/:branch*?server=https%3A%2F%2Fsonarcloud.io&sonarVersion=4.2
TeamCity Simple Build Status:TeamCity Simple Build Status badge/teamcity/build/:verbosity/:buildId?server=https%3A%2F%2Fteamcity.jetbrains.com
TeamCity Full Build Status:TeamCity Full Build Status badge/teamcity/build/:verbosity/:buildId?server=https%3A%2F%2Fteamcity.jetbrains.com
Travis (.org):Travis (.org) badge/travis/:user/:repo
Travis (.org) branch:Travis (.org) branch badge/travis/:user/:repo/:branch
Travis (.com):Travis (.com) badge/travis/com/:user/:repo
Travis (.com) branch:Travis (.com) branch badge/travis/com/:user/:repo/:branch
Visual Studio App Center Builds:Visual Studio App Center Builds badge/visual-studio-app-center/builds/:owner/:app/:branch/: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. All simple-icons are referenced using icon slugs. You can click the icon title on simple-icons to copy the slug or they can be found 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 and Shields logos but not for custom logos. For multicolor Shields logos, the corresponding named logo will be used and colored.
?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