Registry 使用

欢迎来到 Registry 使用文档！本部分将指导您如何在客户端项目中配置和使用私有组件注册表。

概述

私有 Registry 允许您：

🔒 安全访问 - 通过身份验证保护您的组件
📦 快速安装 - 使用 shadcn CLI 一键安装组件
🌐 命名空间 - 支持多个注册表源同时使用
🚀 团队协作 - 在团队和项目间共享组件

快速开始

只需三步即可开始使用私有 Registry：

获取访问令牌

联系您的 Registry 管理员获取访问令牌（REGISTRY_TOKEN）。

配置注册表

在项目的 components.json 中添加注册表配置：

components.json

{
  "registries": {
    "@acme": {
      "url": "https://your-domain.com/api/registry/{name}",
      "headers": {
        "Authorization": "Bearer ${REGISTRY_TOKEN}"
      }
    }
  }
}

安装组件

使用 shadcn CLI 安装组件：

npx shadcn@latest add @acme/button

文档导航

入门指南

了解 Registry 的基本概念和配置方法

快速参考

常用命令和配置的速查表

认证配置

配置多种认证方式保护组件访问

命名空间

使用命名空间管理多个注册表源

典型使用场景

企业设计系统

在企业内部共享统一的设计系统组件：

{
  "registries": {
    "@design-system": {
      "url": "https://design.company.com/r/{name}.json",
      "headers": {
        "Authorization": "Bearer ${DESIGN_TOKEN}"
      }
    }
  }
}

团队协作

不同团队维护各自的组件库：

{
  "registries": {
    "@frontend": "https://frontend.company.com/r/{name}.json",
    "@backend": "https://backend.company.com/r/{name}.json"
  }
}

混合使用

同时使用公共和私有注册表：

{
  "registries": {
    "@shadcn": "https://ui.shadcn.com/r/{name}.json",
    "@internal": {
      "url": "https://internal.company.com/r/{name}.json",
      "headers": {
        "Authorization": "Bearer ${TOKEN}"
      }
    }
  }
}