hyperframes-registry
Install, discover, and wire registry blocks and components into HyperFrames compositions. Use when running hyperframes add or hyperframes catalog, installing one item or every block matching a tag, wiring an installed item into index.html, or working with hyperframes.json. Covers discovery, install locations, block sub-composition wiring, component snippet merging, and authoring a new block or component to contribute upstream (idea → scaffold → validate → PR).
1How It Works & Mechanism
The core mechanism is a local CLI: `hyperframes add` (installs blocks/components) and `hyperframes catalog` (discovery); SKILL.md serves as the CLI runbook rather than an independent implementation; the registry source defaults to registry.json hosted on GitHub raw.
hyperframes add data-chart # install a block hyperframes add grain-overlay # install a component hyperframes add captions # install every block tagged captions
Blocks and components are two distinct integration targets: a block is an independent sub-composition (with its own dimensions, duration, and timeline) wired into the host via `data-composition-src` + data-composition-id/data-start/data-track-index; a component is a dimension-agnostic effect snippet whose HTML, CSS, and JS parts must be manually merged into the host.
<div data-composition-id="data-chart" data-composition-src="compositions/data-chart.html" data-start="2" data-duration="15" data-track-index="1" data-width="1920" data-height="1080" ></div>
The discovery strategy intentionally prioritizes 'intent search over browsing': `catalog --query` provides a local lexical ranking default tier, while `--on-device` requires an opt-in 33MB model download to enable the semantic tier; the search itself 'sends nothing'.
Search is local and sends nothing. By default it ranks on vocabulary shared with the item's name, title and description, so it only finds items that reuse your words; `--on-device` ranks by meaning instead, after a one-time model download.
Catalog gaps are engineered as active reporting channels: `hyperframes feedback --search-miss` is the 'only path that sends a query anywhere', implemented as a separate explicit command (carrying a --tier flag indicating lexical or semantic match), reporting search terms without ratings to guide contribution priorities.
npx hyperframes feedback --search-miss "<the query you ran>" --wanted "<the move you needed>" --tier on-device
Offline/cache semantics are precise: the manifest cache is valid for 24h and serves stale entries if revalidation fails; however, each `add` execution strictly requires network connectivity to fetch files—SKILL explicitly prohibits promising offline installation.
**`add` still needs the network, even for an item you installed yesterday.** Only manifests are cached; the item's actual files are fetched on every install.
The upstream contribution pipeline is fully built-in: the entire idea → scaffold → build → validate → preview → PR flow is documented in references/contributing.md, with starter templates (caption/VFX/component/registry-item.json) provided in templates.md.
To author a NEW registry item (caption style, VFX block, transition, lower third, or a reusable component) and ship it as an upstream PR — not install an existing one — follow the full idea → scaffold → build → validate → preview → ship workflow in [contributing.md](./references/contributing.md).
2Core Capabilities
3External Dependencies
| Kind | Dependency / Endpoint |
|---|---|
| cli | hyperframes CLI(add/catalog/feedback/init;经 npx 或项目内安装) |
| network | registry 源 |
| network | CLI 不可达时的 raw manifest 回退 |
| network | catalog 语义层模型下载(--on-device,一次性、需同意,约 33MB) |
| network | feedback --search-miss 上报(唯一发送查询的命令) |
| network | CDN 依赖(component/demo 模板引 gsap;contributing 流程示例) |
4Recommended Governance & Evidence
- scripts/: Execute local scripts or commands: hyperframes add / npx hyperframes catalog / feedback --search-miss / hyperf
- 网络端点: Declare external network access: registry install fetch: every add retrieves items from raw.githubusercontent.com/heygen-com/hyperframes
- 本地工作目录: File read/write and artifact output: install artifacts: compositions/<name>.html (blocks), compositions/components/<name>.html (c
5Second-Pass Verification
- [ok] registry 端点与回退 curl 行存在 — SKILL.md registry 配置 JSON(第 36 行附近)与 curl 回退命令原文复核一致。
- [ok] 『搜索零外发』与『feedback 外发』并存无矛盾 — 两段原文同页复核:搜索本地词汇排名不发数据;唯一外发被明示为 feedback 命令。
- [ok] on-device 模型下载规模与同意门槛 — 原文 'it needs a consented 33 MB download, so an agent run is on `words` unless it explicitly opted in' 复核一致。
- [ok] SKILL.md 是否自带可执行脚本(隐藏代码面) — find 实测本技能目录仅 SKILL.md + references/(9) + examples/(2),零 .mjs/.py——纯文档技能,能力全部来自 hyperframes CLI。
- [discrepancy] 供应链面(远程 HTML 并入宿主执行)是否如实定级 — 首轮草稿曾倾向 blue(仅『本地 CLI』视角);第二遍重审发现 registry 条目的 HTML/JS 会被安装后并入宿主 composition 执行,且 add 每次联网取文件,属有外发的远程内容信任面,按统一分档『有网络外发按对象分级』定为 yellow 并在 injection_surface 显式说明。
6Verdict & Scenarios
f0bfec893d952c12…