Home / All Skills / Content & Media Creation / hyperframes-registry
Content & Media Creation · heygen-com/hyperframes

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).

L4 High-Privilege · Graded auth & full auditV1 Commit-PinnedExecute CommandNetwork AccessWrite FileDual-pass Audit
Author heygen-comGitHub heygen-com/hyperframes ↗Stars 48297License Apache-2.0(仓库根 LICENSE;GitHub API spdx Apache-2.0)Commit b8328f9573
Control levels describe skill capabilities and suggested control measures; they do not represent quality or safety certifications, nor do they dictate usability. Usage decisions rest entirely with users and administrators. Different agent hosts apply varying constraints; do not assume hosts provide automatic protection. Third-party skill copyrights belong to their original authors. Use at your own risk.

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.

skills/hyperframes-registry/SKILL.md
hyperframes add data-chart # install a block hyperframes add grain-overlay # install a component hyperframes add captions # install every block tagged captions
Registry location is configurable: '"registry": "https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry"' (from an embedded hyperframes.json snippet in SKILL.md)—blocks and components are fetched from this source by the CLI.

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.

skills/hyperframes-registry/SKILL.md
<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>
SKILL.md details the exact semantics of key attributes (data-composition-src path, data-composition-id matching the block's internal ID, data-start/duration in seconds, data-track-index layer order) and guides full steps via references/wiring-blocks.md and wiring-components.md.

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'.

skills/hyperframes-registry/SKILL.md
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.
SKILL.md also specifies that queries must be in English (catalog dual-index, on-device model is English-only), otherwise returning 'No searchable words in query'—framing common failure modes as system rules rather than bugs.

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.

skills/hyperframes-registry/SKILL.md
npx hyperframes feedback --search-miss "<the query you ran>" --wanted "<the move you needed>" --tier on-device
The context is clear: 'This is the only path that sends a query anywhere, which is exactly why it is a separate deliberate command rather than something the search does on its own.'—outbound transmission is strictly restricted to a single predictable command.

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.

skills/hyperframes-registry/SKILL.md
**`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.
A fallback for when the CLI is unreachable is provided as an explicit curl example: 'curl -s https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/registry.json' (SKILL.md).

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.

skills/hyperframes-registry/SKILL.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).
SKILL.md explicitly lists 'authoring a new block or component to contribute upstream (idea → scaffold → validate → PR)' in its scope—positioning the registry as an interface for both consumption and contribution.

2Core Capabilities

01Installing single items, batch-installing by tag, custom directories, and machine-readable output (all variations of hyperframes add)
02Intent-driven catalog search and browse filtering (--query/--type/--tag/--json/--human-friendly)
03Customizing install locations and hyperframes.json path configurations (blocks/components/assets)
04Block wiring guidance: data-composition-src/ID/start/duration/track-index semantics
05Component sandwich wiring guidance (merging HTML/CSS/JS chunks into host + GSAP timeline integration)
06Reporting catalog search misses (feedback --search-miss, the sole path that transmits queries)
07Upstream contribution workflow: idea → scaffold → validate → PR and component quality standards (component-quality-bar)

3External Dependencies

KindDependency / Endpoint
clihyperframes CLI(add/catalog/feedback/init;经 npx 或项目内安装)
networkregistry 源
networkCLI 不可达时的 raw manifest 回退
networkcatalog 语义层模型下载(--on-device,一次性、需同意,约 33MB)
networkfeedback --search-miss 上报(唯一发送查询的命令)
networkCDN 依赖(component/demo 模板引 gsap;contributing 流程示例)

4Recommended Governance & Evidence

Suggested Controls for Safe Operation
For Agent Runtime
Graded/per-use authorization, sandbox recommended
For Administrators
Approval workflow, rollback support, full audit
Evidence & Triggers (File Paths & Excerpts)
  • 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
Audit Notes: Standard network requests targeting predictable destinations: local search sends zero telemetry; outbound calls are confined to the official GitHub raw registry (fetching item files on add), an optional opt-in 33MB on-device model download, explicit feedback --search-miss reporting (transmitting query text), and initial package fetching via npx. No credential reading or token handling. The primary consideration is supply-chain trust regarding remote registry HTML snippets merged into executable compositions, along with custom registry source credibility—nonetheless, all outbound destinations are official and predictable, warranting a yellow rating rather than higher.

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

  • Clear and predictable network discipline: zero traffic for default searches, narrowing outbound calls to installation, feedback, and model download
  • Honest layering across dual-tier cataloging, installability, and offline boundaries, preventing agents from mistaking expected behaviors for bugs
  • Strict and unambiguous wiring semantics (data-composition-src/id/start/track-index), minimizing sub-composition assembly defects
  • Unified consumption and contribution lifecycle with built-in quality bars, channeling gaps back into upstream contributions
  • Best for: Ideal for any authoring session that needs to reuse catalog blocks or components within HyperFrames compositions (charts, grain overlays, transitions, subtitle styles), as well as contributors looking to add items to the catalog (covers the full idea → PR workflow).
    Not for: Not suitable for offline rendering or offline installation environments (add strictly requires network access); not suitable for minimal compositions that do not require a registry (consult hyperframes-core first); not suitable for exploratory sessions aiming to handcraft component styles from scratch without checking the catalog (search catalog first, then handcraft).
    Install Agent-Ready
    ① Verified Mirror 2026-09-09
    Option A · Direct DownloadDownload hyperframes-registry.tar.gz
    sha256: f0bfec893d952c12…
    Option B · Copy Guide for Agent
    install.json
    Agents automatically download and verify mirrors from this JSON guide.
    ② Upstream GitHub
    GitHub Repo ↗
    Pinned to commit b8328f9573.