125k

2026 年 6 月 - GitHub レジストリ

パブリック GitHub リポジトリを shadcn レジストリに変換します。

パブリック GitHub リポジトリをレジストリに変えることができるようになりました。

リポジトリのルートに registry.json ファイルを追加し、配布したいアイテムを定義します。ユーザーは shadcn CLI を使って GitHub から直接インストールできるようになります。

pnpm dlx shadcn@latest add <username>/<repo>/<item>

たとえば、acme/toolkit リポジトリから project-conventions アイテムをインストールするには、次のようにします。

pnpm dlx shadcn@latest add acme/toolkit/project-conventions

GitHub レジストリはソース レジストリです。shadcn build を実行したり、生成したアイテムの JSON ファイルを公開したり、レジストリ サーバーをセットアップしたりする必要はありません。CLI がルートの registry.json を読み込み、include エントリを解決し、要求されたアイテムを検索して、そのアイテムで宣言されたファイルをインストールします。

何でも配布

レジストリのアイテムはコンポーネントに限定されません。GitHub レジストリは、コンポーネント、フック、ユーティリティ、デザイントークン、機能キット、プロジェクト規約、エージェントの指示、テスト設定、CI ワークフロー、リリース ワークフロー、テンプレート、codemod、移行キット、その他のプロジェクト ファイルなど、あらゆるものを配布できます。

たとえば、リポジトリは、共有ドキュメント、エディタ設定、エージェントの指示をインストールする project-conventions アイテムを公開できます:

registry.json
{
  "$schema": "https://ui.shadcn.com/schema/registry.json",
  "name": "acme-toolkit",
  "homepage": "https://github.com/acme/toolkit",
  "items": [
    {
      "name": "project-conventions",
      "type": "registry:item",
      "files": [
        {
          "path": "AGENTS.md",
          "type": "registry:file",
          "target": "~/AGENTS.md"
        },
        {
          "path": ".editorconfig",
          "type": "registry:file",
          "target": "~/.editorconfig"
        },
        {
          "path": "docs/conventions.md",
          "type": "registry:file",
          "target": "~/docs/conventions.md"
        }
      ]
    }
  ]
}

コマンド

GitHub レジストリのアドレスは、他のレジストリ アドレスと同じコマンドで動作します。

GitHub レジストリのアイテムを一覧表示します。

pnpm dlx shadcn@latest list acme/toolkit

アイテムを検索します:

pnpm dlx shadcn@latest search acme/toolkit --query conventions

アイテムを表示します:

pnpm dlx shadcn@latest view acme/toolkit/project-conventions

アイテムをインストールします。

pnpm dlx shadcn@latest add acme/toolkit/project-conventions

完全なガイドについては、GitHub Registries のドキュメントを参照してください。