# @clay-design-system/registry 中文文档

规范地址：https://npmcn.com/package/%40clay-design-system/registry/

版本：0\.24\.0
npm 元数据更新时间：2026-11-09T17:50:50.600Z
中文译文更新时间：2026-11-10T00:35:16.246Z
软件包许可：未声明

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40clay-design-system/registry
原文对照：https://npmcn.com/package/%40clay-design-system/registry/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：26.5 MB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.13
- 运行依赖：0 个
- 首次发布：2026-10-18T17:31:58.460Z
- 最新版本发布：2026-11-09T17:50:50.347Z
- 近 30 天下载量：1858（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 15 个）

## 中文简介

克莱登记处:星期一。 com的营销设计系统作为一个可查询的数据库(组件,路段,信使,资产,规则),具有零依赖性查询层.

## 安装

```sh
npm install @clay-design-system/registry
```

也可以使用：`pnpm add @clay-design-system/registry`、`yarn add @clay-design-system/registry`、`bun add @clay-design-system/registry`

## README

# @clay-design- system/ registry (英语)

克莱登记处:星期一。 com的营销设计系统(组件、分块、信使、资产、规则)作为一个可查询系统 SQLite数据库,有一个查询层,没有运行时间依赖性. 只读;不包括内部单位.

要求数 **节点 22.13** (使用内置) `node:sqlite`,不需要旗帜).

## 安装

```sh
pnpm add @clay-design-system/registry
```

## 使用

```js
import { search, get, assetUrl } from '@clay-design-system/registry'

search('hero section')                          // ranked hits: [{ id, kind, name, summary, links, score }, …]
get('section.FeaturesSection')                  // one compact record (import path, story, Figma and CDN links)
get('section.FeaturesSection', { detail: true }) // every column, plus links, relations and renders
assetUrl('asset.icon.calendar')                 // https://… CDN URL
```

## 语义搜索( 可选)

数据库每个记录带有一英寸8句矢量(`embeddings`, (中文(简体) ), `meta.embedding_model`) (中文(简体) ). `searchHits(query, { vector })` 在通过查询嵌入时,用BM25来引导其余弦排列; `await registry.embed(query)` 选择时计算 `@clay-design-system/embeddings` 软件包已安装(在工作目录或 `CLAY_EMBED_DIR`它携带23 MB 微型LM 重量,所以没有下载; `CLAY_SEMANTIC=0` 禁用它). 没有矢量,或者没有那个包, `search` bM25和以前一样 软件包也没有任何依赖性.

```js
const reg = openRegistry()
const vector = await reg.embed('airy breathing room between big blocks on phones') // undefined when semantic search is off
reg.search('airy breathing room between big blocks on phones', { vector })
```

也导出 : `list`, (中文(简体) ), `related`, (中文(简体) ), `assetVariants`, (中文(简体) ), `componentsUsingToken`, (中文(简体) ), `allowedChildren`, (中文(简体) ), `pageRecipe`, (中文(简体) ), `openRegistry`, (中文(简体) ), 页:1 `Registry` 类,反应类型,以及 `DB_PATH` (绝对路径 运出 `data/clay.sqlite`时建造 软件包是构建的; 在 repo 中被 gitignored 。 该数据库是唯一的数据文件:每个记录,链接和关系都在其中.

## 常见问题

### @clay-design-system/registry 是什么？

克莱登记处:星期一。 com的营销设计系统作为一个可查询的数据库\(组件,路段,信使,资产,规则\),具有零依赖性查询层\.

### 如何安装 @clay-design-system/registry？

在项目目录运行 npm install @clay-design-system/registry，或使用 pnpm add / yarn add / bun add。

### @clay-design-system/registry 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @clay-design-system/registry 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @clay-design-system/registry 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.13。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @clay-design-system/registry 可以商用吗？

@clay-design-system/registry 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @clay-design-system/registry 的下载量有多少？

根据 npm 官方下载统计，@clay-design-system/registry 在 2026/10/10 – 2026/11/08 这 30 天内被下载 1,858 次，日均约 62 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @clay-design-system/registry 还在维护吗？

最新版本 0\.24\.0 发布于 2026/11/10（今天）；至今共发布 15 个版本，其中过去 12 个月发布了 15 个；首次发布于 2026/10/19。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。