badges/shields

これは何？

主な機能

• 01アカウント不要で、URLからSVG・ラスター形式のバッジを生成
• 02多数のCIサービス、パッケージレジストリ、アプリストア、コード解析ツールに対応
• 03コードからバッジを生成するbadge-maker NPMライブラリを提供
• 04任意のラベルや色を指定できるカスタム静的バッジに対応
• 05SentryとPrometheusの任意連携に対応し、セルフホスト可能

ユースケース

• GitHubのREADMEにビルド、カバレッジ、バージョンのバッジを追加する
• プロジェクトのホームページにパッケージのダウンロード数やリリースバージョンを表示する
• badge-makerを使い、Node.jsのビルドスクリプトからプログラムでバッジを生成する
• 組織内向けのプライベートなバッジサーバーをホストする

クイックスタート

1. 1

   お好みのパッケージマネージャーを使って Node 24 をインストールします

2. 2

   このリポジトリをクローンします

3. 3

   依存関係をインストールします

   npm ci
4. 4

   バッジサーバーとフロントエンドの開発サーバーを起動し、http://localhost:3000/ を開きます

   npm start

使う前に知っておきたいこと

• !開発環境のセットアップには Node 24 とリポジトリ全体のクローンが必要です。

トピック

よくある質問

shields とは？

Shields.ioは、READMEやWebページ向けの簡潔なSVG・ラスター形式のステータスバッジを生成するサービス兼NPMライブラリです。 Shields.ioは、ステータス、バージョン、ダウンロード数、カバレッジなどの指標を一貫した見やすいバッジで表示します。CIサービス、パッケージレジストリ、アプリストア、コード解析ツールなどのデータソースをURLで指定するとバッジが作成され、その画像をGitHubのREADMEやその他のWebページに埋め込めます。数多くの継続的インテグレーションサービス、パッケージレジストリ、ディストリビューション、ソーシャルネットワーク、コード品質ツールに対応しています。

shields は無料で使えますか？ライセンスは？

shields は Apache-2.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

shields は今もメンテナンスされていますか？

活発にメンテナンス中。shields の最終コミットは 2026年11月6日 です。

shields は何に使えますか？

GitHubのREADMEにビルド、カバレッジ、バージョンのバッジを追加する プロジェクトのホームページにパッケージのダウンロード数やリリースバージョンを表示する badge-makerを使い、Node.jsのビルドスクリプトからプログラムでバッジを生成する 組織内向けのプライベートなバッジサーバーをホストする

shields のインストール方法は？

お好みのパッケージマネージャーを使って Node 24 をインストールします このリポジトリをクローンします 依存関係をインストールします: npm ci バッジサーバーとフロントエンドの開発サーバーを起動し、http://localhost:3000/ を開きます: npm start

shields はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/badges/shields