HyperFrames 레지스트리은(는) 무엇을 하나요?
레지스트리는 hyperframes add <name> 명령어로 설치 가능한 재사용 가능한 블록과 컴포넌트를 제공합니다.
- 블록(Blocks) — 독립형 서브 컴포지션 (자체 크기, 지속 시간, 타임라인 소유). 호스트 컴포지션에서
data-composition-src속성을 통해 포함됩니다. - 컴포넌트(Components) — 이펙트 스니펫 (자체 크기 없음). 호스트 컴포지션의 HTML에 직접 붙여넣습니다.
빠른 참조
hyperframes add data-chart # 블록 설치
hyperframes add grain-overlay # 컴포넌트 설치
hyperframes add captions # 'captions' 태그의 모든 블록 설치
hyperframes add shimmer-sweep --dir . # 특정 프로젝트 대상 지정
hyperframes add data-chart --json # 기계 판독 가능 출력
hyperframes add data-chart --no-clipboard # 클립보드 건너뛰기 (CI/헤드리스)
설치 후, CLI는 어떤 파일이 작성되었는지와 호스트 컴포지션에 붙여넣을 스니펫을 출력합니다. 이 스니펫은 시작점일 뿐입니다. 블록을 연결할 때는 data-composition-id (블록의 내부 컴포지션 ID와 일치해야 함), data-start, data-track-index 속성을 추가해야 합니다.
위치 인자는 먼저 정확한 아이템 이름으로 해석됩니다. 일치하는 아이템이 없고 인자가 태그인 경우, 해당 태그를 가진 모든 블록을 설치합니다. 레지스트리 의존성은 요청된 아이템보다 먼저 설치됩니다. hyperframes add는 블록과 컴포넌트에만 사용됩니다. 예제는 hyperframes init <dir> --example <name>을 대신 사용하세요.
설치 위치
블록은 기본적으로 compositions/<name>.html에 설치됩니다. 컴포넌트는 기본적으로 compositions/components/<name>.html에 설치됩니다.
이 경로들은 hyperframes.json에서 설정 가능합니다:
{
"registry": "https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry",
"paths": {
"blocks": "compositions",
"components": "compositions/components",
"assets": "assets"
}
}
자세한 내용은 install-locations.md를 참조하세요.
블록 연결하기
블록은 독립형 컴포지션입니다. 호스트 index.html에서 data-composition-src를 통해 포함시킵니다:
<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>
주요 속성:
data-composition-src— 블록 HTML 파일 경로data-composition-id— 블록의 내부 ID와 일치해야 함data-start— 호스트 타임라인에서 블록이 나타나는 시간 (초)data-duration— 블록 재생 시간data-width/data-height— 블록 캔버스 크기data-track-index— 레이어 순서 (숫자가 클수록 앞쪽)
자세한 내용은 wiring-blocks.md를 참조하세요.
컴포넌트 연결하기
컴포넌트는 스니펫입니다. HTML을 컴포지션 마크업에, CSS를 스타일 블록에, JS를 스크립트(있는 경우)에 붙여넣습니다:
- 설치된 파일을 읽습니다 (예:
compositions/components/grain-overlay.html) - HTML 요소들을 컴포지션의
<div data-composition-id="...">안으로 복사합니다 <style>블록을 컴포지션의 스타일로 복사합니다- 모든
<script>내용을 컴포지션의 스크립트(타임라인 코드 앞)로 복사합니다 - 컴포넌트가 GSAP 타임라인 통합을 제공하는 경우 (스니펫의 주석 블록 참조), 해당 호출을 타임라인에 추가합니다
자세한 내용은 wiring-components.md를 참조하세요.
검색
CLI를 기본 검색 도구로 사용하세요. 의도 기반으로 검색하고, 브라우징은 피하세요: 레지스트리는 눈으로 훑어볼 수 있는 것보다 훨씬 많은 아이템을 보유하고 있으므로, 이름이나 태그로 나열하고 일치시키는 것은 느린 방법이며, 작성자의 단어가 사용자의 단어와 다를 때마다 실패합니다.
# 전체 카탈로그를 비트가 수행해야 할 작업에 대해 순위화
npx hyperframes catalog --query "헤드라인이 한 줄씩 나타나게 하기"
npx hyperframes add caption-clip-wipe
검색은 로컬에서 이루어지며 아무것도 전송하지 않습니다. 기본적으로 아이템의 이름, 제목 및 설명과 공유되는 어휘를 기준으로 순위를 매기므로, 사용자의 단어를 재사용하는 아이템만 찾습니다. --on-device는 일회성 모델 다운로드 후 의미 기반으로 순위를 매깁니다. --json과 함께 사용하면 응답한 계층이 표시되므로, 순위가 발생했다고 가정하지 말고 이를 확인하세요.
비디오의 언어와 관계없이 항상 영어로 질의하세요. 카탈로그는 영어로 작성되었으며, 두 계층 모두 해당 방식으로 인덱싱합니다(온디바이스 모델도 영어 전용입니다). 다른 스크립트로 질의하면 검색 가능한 용어가 생성되지 않아 아무것도 반환되지 않습니다. 일본어나 중국어 프로젝트에서 브리프, 캡션, 내레이션이 모두 해당 언어로 되어 있고 질의도 자연스럽게 그렇게 따라가는 경우 실수하기 쉽습니다. 동작 은 영어로 설명하고, 화면에 표시될 텍스트는 비디오에 필요한 언어로 작성하세요. 질의가 No searchable words in query를 반환하면, 이는 누락된 컴포넌트가 아니라 이 규칙 때문이며, 갭 리포트를 작성할 가치가 없습니다.
설치 가능성은 순위화 후에 적용되며, 그 전에 적용되지 않습니다. 벡터가 전달하지만 이 레지스트리가 제공할 수 없는 이름은 결과에서 제외되고 dropped에 집계됩니다. 따라서 0이 아닌 dropped는 두 항목이 다른 세대임을 의미합니다. 오프라인 계층, 동의 게이트 및 오래된 인덱스 새로 고침 방법은 /hyperframes-cli를 참조하세요.
검색 대신 브라우징하거나 필터링하려면:
npx hyperframes catalog
npx hyperframes catalog --type block
npx hyperframes catalog --type component
npx hyperframes catalog --type block --tag social
npx hyperframes catalog --json
npx hyperframes catalog --human-friendly
일반 테이블 및 --json 모드는 일치하는 항목만 나열합니다. 선택한 이름은 hyperframes add <name>으로 설치하세요. --human-friendly는 대화형 선택기를 열고 선택한 항목을 즉시 설치합니다. CI 또는 에이전트 워크플로우에서는 --json 다음에 명시적인 add를 사용하는 것이 좋습니다.
카탈로그에 없는 항목 보고
검색 결과에 적합한 항목이 없을 때, 수동으로 동작을 만들기 전에 그 사실을 알리세요:
npx hyperframes feedback --search-miss "<실행한 질의>" --wanted "<필요한 동작>" --tier on-device
catalog --query는 이 라인을 미리 채워서 출력하며, --json은 이를 report_gap으로 전달합니다. 따라서 아무것도 맞지 않는다고 판단하는 순간 이미 준비된 것입니다.
어느 계층에서든 결과에 적합한 항목이 없으면 보고하세요. 온디바이스 계층이 응답할 때까지 기다리지 마세요. 동의된 33MB 다운로드가 필요하므로, 명시적으로 옵트인하지 않으면 에이전트 실행은 words에서 실행되며, on-device에 조건을 걸면 거의 모든 보고가 차단됩니다. --tier 값은 함께 전달되므로, 읽을 때 어휘 누락과 의미 누락을 구별할 수 있습니다. 상상한 아이템 이름이 아니라 원했던 효과 를 설명하세요. 결과는 구축할 가치가 있는 동작 목록이며, 존재하지 않는 아이템을 명명한 보고서는 아무것도 가르쳐주지 않습니다. 이것이 어디로든 질의를 보내는 유일한 경로이며, 이것이 바로 검색이 자체적으로 수행하는 것이 아니라 별도의 의도적인 명령인 이유입니다. 등급을 포함하지 않으며 등급 지표에 포함되지 않습니다.
이것이 카탈로그에 대한 전체 수요 신호입니다. 이를 건너뛰면 직면한 갭이 설치 횟수로부터 추측되며, 이는 아무도 설치할 수 없는 동작을 볼 수 없습니다.
CLI가 설정된 레지스트리에 연결할 수 없는 경우, 대체 수단으로 원시 매니페스트를 검사하세요:
curl -s https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/registry.json
CLI가 연결할 수 없는 레지스트리는 검색용 카탈로그를 비우지 않습니다: 재검증에 실패할 때마다 이전에 가져온 매니페스트가 24시간 새로 고침 기간을 초과하여 계속 제공되므로, catalog 및 catalog --query는 여전히 디스크의 마지막 복사본에 대해 목록을 작성하고 순위를 매깁니다.
add는 어제 설치한 아이템에도 여전히 네트워크가 필요합니다. 매니페스트만 캐시됩니다. 아이템의 실제 파일은 매 설치마다 가져옵니다. 따라서 오프라인에서는 검색할 수 있고 아이템이 무엇인지 볼 수 있지만, 설치하려고 하면 파일 가져오기에서 실패합니다. 사용자에게 오프라인 설치를 약속하지 마세요.
각 아이템의 registry-item.json에는 이름, 유형, 제목, 설명, 태그, 크기(블록만), 지속 시간(블록만), 파일 목록이 포함됩니다.
유형 및 태그별 필터링에 대한 자세한 내용은 discovery.md를 참조하세요.
새 블록 또는 컴포넌트 기여하기
새로운 레지스트리 아이템(캡션 스타일, VFX 블록, 전환, 하단 1/3, 또는 재사용 가능한 컴포넌트)을 작성하여 상위 저장소에 PR로 제출하려면 — 기존 아이템을 설치하는 것이 아니라 — contributing.md의 전체 아이디어 → 스캐폴드 → 빌드 → 검증 → 미리보기 → 배송 워크플로우를 따르세요. 복사-붙여넣기 가능한 스타터 템플릿(캡션 / VFX / 컴포넌트 / registry-item.json)은 templates.md에 있습니다.