Hyperframes Registry

Plugin installs: Inside a HyperFrames plugin, follow plugin execution rules (opens in a new tab).

Usage beacon: run npx hyperframes events --skill=hyperframes-registry once as this skill starts. It sends the skill’s name with the CLI’s usual telemetry (account-linked when signed in) and honours the opt-out.

HyperFrames registry

Starting from an item is faster and usually better than writing the effect yourself, and an installed item is ordinary source in your project: change it, cut it down, restyle it.

Find and install

There is no hyperframes registry command; searching is catalog, installing is add.

npx hyperframes catalog --query "<what the beat should do, in English>" --json
npx hyperframes add <name> --json        # prints the written files and the mount snippet

• Query in English even when the video is not: the catalog is indexed in English, and another script returns No searchable words in query, which is not a gap.
• Search is local and sends nothing. The default words tier only finds items that reuse your words; --on-device ranks by meaning after a one-time ~33 MB download. Offer that download and let the person decide; never enable it silently. The --json envelope names the tier that answered.
• Narrow with --type block|component and --tag <tag>. add <tag> installs every block with that tag; dependencies install first. add needs the network even for an item installed before; search works offline from the cached manifest.
• Nothing fits: report it before you hand-build, on either tier. catalog --query prints the line pre-filled (report_gap in --json): npx hyperframes feedback --search-miss "<query>" --wanted "<the move you needed>" --tier <tier>. Describe the effect, not an item name you imagined.

Tiers, dropped and unindexed, stale indexes, offline behaviour: references/search.md.

What’s in it

Wiring

• Block: installs to compositions/<name>.html. Mount it with data-composition-src, data-composition-id matching the block’s own id, data-start and the data-duration you need; the snippet add prints is the starting point. references/wiring-blocks.md.
• Component: installs to compositions/components/<name>.html. Copy its markup, <style> and script into your scene, and follow its comment block if it hooks into your timeline. references/wiring-components.md.
• Take the largest unit that fits, then edit it. Keep an installed item’s ids prefixed as they are, so two items can’t collide.
• An item keeps its own variables; set them for one mount with data-variable-values on its host (add --vars '{"title":"…"}' writes that), and point its colour and font variables at your brand’s.
• Beat-synced blocks take hit times from npx hyperframes beats --json: the beat times minus the mount’s data-start.
• Install paths come from hyperframes.json (references/install-locations.md).

Contributing

Authoring a new block or component for an upstream PR: references/contributing.md, starter templates in references/templates.md, quality bar in references/component-quality-bar.md.