HyperFrames CLI
프로젝트 지침에 래퍼가 제공되지 않는 한 npx hyperframes ...로 명령을 실행합니다. 래퍼가 있으면 이를 따릅니다. CLI는 Node.js 22 이상과 FFmpeg가 필요합니다.
개발 루프
- 스캐폴딩:
npx hyperframes init <project>(가운데 정렬 빈 프로젝트). 또는 사이트를 캡처합니다.--example=<name>은 명명된 예제에서 시작할 때만 전달합니다. - 동작 찾기: 요청에 자산, 사운드, 이미지, 음성 또는 빠른 시각적 편집이 포함된 경우, 계획을 제안하기 전에
/media-use를 통해 해결합니다. 그렇지 않으면 수동으로 모션을 작성하기 전에 이미 해당 동작을 수행하는 프리미티브가 있는지 검색합니다:npx hyperframes catalog --query "헤드라인을 한 줄씩 드러내기". 원하는 효과를 물어보세요. 염두에 둔 메커니즘을 묻지 마세요.npx hyperframes add <name>으로 설치합니다(/hyperframes-registry참조). 맞는 것이 없을 때만 수동으로 작성합니다. - 작성:
/hyperframes-core를 사용하여 컴포지션을 작성합니다. 프로젝트 타임라인에 무엇이 있는지(트랙, 클립, 시작, 끝, 재생) 확인하려면index.html과 모든 서브 컴포지션 파일을 읽는 대신npx hyperframes timeline --json을 실행합니다. 중첩된 행은 절대 메인 타임라인absStart/absEnd와 소유file을 전달합니다(로컬 서브 컴포지션 시간만이 아닙니다). 텍스트 형식보다--json을 선호합니다. 동일하거나 더 나은 정확성으로 더 적은 토큰을 사용합니다. 전체 출력을 읽지 않고 일반적인 질문에 답하는 한 줄짜리 명령어는references/upgrade-info-misc.md를 참조하세요. - 편집 중 빠른 피드백: 첫 번째 HTML 패스 후와 구조적 변경 후에
npx hyperframes lint를 실행합니다. - 최종 게이트 실행:
npx hyperframes check를 실행합니다. lint를 먼저 실행한 후 브라우저를 엽니다. 중복된 독립 lint 호출을 앞에 추가하지 마세요. 주석이 달린 개요 프레임과 크롭 찾기를 위해--snapshots를 추가합니다. - 서브 컴포지션 검사:
index.html이data-composition-src를 마운트하는 경우, 중간 지점 스냅샷을 캡처하고 각 마운트된 씬을 검사합니다. - 최종 Studio 프리뷰 열기:
npx hyperframes preview --background를 실행하고 URL이 HTTP 200을 반환하는지 확인한 후, 타임라인 프로젝트 URL을 사용자에게 전달하고 수정할지 렌더링할지 물어봅니다. 검토가 끝날 때까지 프리뷰를 유지합니다. - 승인 후에만 렌더링: 반복 중에는
--quality draft를 사용하고, 첫 번째 실제 인코딩에는--quality looks(CLI 기본값)를 사용하고, 최종 전달에는--quality delivery를 사용합니다. - 출력 확인: 파일이 존재하고 비어 있지 않은지 확인합니다. 렌더링 요약의 두 번째 줄(
beginframevsscreenshot, GPU, 단계 타이밍)을 읽습니다. Linux에서screenshot+software gpu는 느린 경로입니다.ffprobe -v error -show_format -show_streams를 실행하고 지속 시간(및 브리핑에서 설정한 경우 fps)을 루트data-duration과 비교합니다.
필수 크리에이터 편집 상호 참조
- 줌, 펀치 인/아웃, 리프레임, 카메라 무브 또는 키프레임 모션을 작성하거나 진단하기 전에 먼저
/hyperframes-keyframes를 읽으세요. hyperframes keyframes전에/hyperframes-keyframes를 읽으세요. 이 명령어는 애니메이션 궤적을 표시하며 클립 컷을 진단하지 않습니다.- 컷, 트림, 스플라이스, 재정렬 또는 소스 타이밍 편집의 경우
/hyperframes-core를 읽고 해당 클립/타임라인 계약을 사용하세요. - 페이드 인/아웃, 크로스페이드, 트랙 게인, 볼륨 자동화, 덕킹, 보이스오버 커브 또는 배치된 오디오에 대한 FX의 경우
/hyperframes-audio를 읽으세요. 클립 배치나 사진 타이밍도 변경되는 경우 코어를 함께 로드하세요. - 자산, 사운드, 이미지, 음성 또는 빠른 시각적 편집을 요청하는 요청은 계획이 제안되기 전에
/media-use를 통해 해결됩니다. 크리에이터 편집 마크업을/hyperframes-core→references/creator-editing-recipes.md에서 복사하세요.
# 빠른 반복 점검; 작성 중 필요에 따라 반복하세요.
npx hyperframes lint
# 필요한 최종 게이트; lint를 포함합니다.
npx hyperframes check
npx hyperframes preview --background
npx hyperframes render --quality looks --output out.mp4
test -s out.mp4
ffprobe -v error -show_format -show_streams out.mp4
check는 lint를 먼저 실행한 후 하나의 브라우저 세션과 하나의 시크 패스를 사용하여 런타임 오류, 실패한 요청, 레이아웃, *.motion.json 어설션 및 WCAG 대비를 감사합니다. 지속적인 발견은 종료 코드를 게이트합니다. 일시적인 진입 또는 종료 발견은 정보 제공용입니다. 경고를 게이트하려면 --strict를 사용하세요. validate, inspect, layout은 호환성을 위해 별칭으로 남아 있지만 새 명령어나 스크립트에 나타나서는 안 됩니다.
렌더링 전 프리뷰
check가 통과한 후에만 최종 컴포지션 프리뷰(#project/<name>)를 열어 조립된 타임라인을 검토합니다. 채팅의 계획과 storyboard.html 스케치 시트는 최종 비디오의 승인이 아닙니다. 렌더링은 항상 hyperframes/references/review-loop.md에 정의된 최종 승인이 필요합니다.
서브 컴포지션 스모크 테스트
정적 감사는 모든 마운트 실패를 잡을 수 없습니다. 프로젝트가 서브 컴포지션을 사용하는 경우 각 호스트 슬롯에 대해 적어도 하나의 보이는 중간 지점을 캡처합니다:
npx hyperframes snapshot --at <t1>,<t2>,<t3>
작은 스타일 없는 콘텐츠, 캔버스 크기 아이콘, 누락된 히어로 요소 또는 타임라인 등록 시간 초과를 렌더링 차단 마운트 결함으로 처리합니다. 해당 수정 사항은 hyperframes-core/references/sub-compositions.md를 참조하세요.
에이전트 규칙
-
수동 모션 작성 전에 카탈로그를 검색하세요.
npx hyperframes catalog --query "<평범한 영어로 된 비트>". 검색은 완전히 로컬입니다: 호스팅 계층, 계정이 없으며 쿼리 텍스트는 어디로도 전송되지 않습니다. 기본적으로 항목의 이름, 제목, 설명 및 태그와 공유된 어휘로 순위를 매기므로 카탈로그 자체의 표현을 재사용하지 않는 구문은 놓칩니다. 대신 의미로 순위를 매기려면--on-device를 추가하세요(아래 오프라인 계층 참조). -
비디오 언어와 관계없이 영어로 쿼리하세요. 두 계층 모두 영어 카탈로그를 인덱싱하므로 다른 스크립트로 된 쿼리는 검색 가능한 용어를 생성하지 않으며 아무것도 반환하지 않습니다. 동작을 영어로 설명하세요. 화면상의 텍스트는 비디오에 필요한 어떤 언어로든 유지됩니다. '검색 가능한 단어가 쿼리에 없음'은 정확히 이것을 의미하며 누락된 구성 요소가 아니므로 카탈로그 격차로 보고하지 마세요.
-
응답한 계층을 읽고 결과가 나타났다고 추론하지 마세요.
--json을 사용하면 봉투에query,tier(on-device또는words),tier_detail,dropped,unindexed,shown,total및results가 포함되며, 응답 계층이 생성할 때top_score와 계층이 요청되었지만 실행할 수 없거나 검색이 아무것도 반환하지 않았지만 더 나은 계층이 누군가의 동의를 기다리고 있을 때warnings도 포함됩니다.words에 대한 약한 결과는 예상됩니다.on-device에 대한 동일한 결과는 버그입니다.top_score는 on-device 전용이며 그 뒤에 임계값이 없습니다: 랭커는 모든 쿼리에 대해 전체 카탈로그를 어떤 순서로든 반환하므로 이를 통과 또는 실패가 아닌 증거로 읽으세요. -
dropped와unindexed는 레지스트리와 온디바이스 인덱스 간의 반대 방향 편향이며 쿼리를 다시 작성해도 둘 다 해결되지 않습니다.dropped는 이 레지스트리가 설치할 수 없는 순위가 매겨진 이름의 수를 계산하므로 가장 강력한 일치 항목이 손실되는 것입니다.unindexed는 인덱스가 전혀 볼 수 없는 레지스트리 이동의 수를 계산하며 어떤 쿼리도 반환할 수 없습니다. 레지스트리 새로 고침은 둘 중 하나에 대한 답이 아닙니다. 매니페스트는 24시간 TTL을 가지며 자체 복구되는 반면, 벡터는~/.hyperframes/catalog/로 가져온 별도로 게시된 아티팩트입니다.unindexed가 0보다 크면--on-device로 다시 실행하면 해당 인덱스를 다시 가져오므로 이것이 사용자에게 제공할 해결책입니다. 순수한 과잉 적용 범위 편향(dropped가 0보다 크고unindexed가 0)은 다시 가져오기를 트리거하지 않습니다.~/.hyperframes/catalog/를 지우는 것이 유일한 방법입니다. 두 개수 모두 결과 수가 아닌 이름 수이므로 둘 다total을 초과할 수 있습니다. -
검색에서 설치할 가치가 있는 것이 없으면 그렇게 말하세요.
npx hyperframes feedback --search-miss "<실행한 쿼리>" --wanted "<필요한 동작>" --tier <응답한 계층>. 해당 줄을 조합할 필요는 없습니다:catalog --query는 미리 채워서 출력하고 모든--json검색 봉투는 쿼리와 계층이 이미 올바른report_gap을 전달합니다.--wanted를 채워서 보내세요. 이것이 쿼리를 어디로든 보내는 유일한 경로이며, 일반catalog --query가 아무것도 보내지 않겠다는 약속을 지키기 위해 정확히 별도의 의도적인 명령어입니다. 결과가 작업을 수행하지 않을 때마다 어느 계층에서든 보고하세요. 동의가 필요한 33MB 다운로드가 필요하고 따라서 대부분의 에이전트 실행에서 꺼져 있는 온디바이스 계층을 기다리지 마세요. 기다리면 결코 보고하지 않게 됩니다. 계층은 보고서에 함께 실려 있으므로 어휘 누락과 의미 누락을 직접 판단할 필요 없이 구분할 수 있습니다. 돌아오는 것은 카탈로그에 아직 없는 동작의 목록이며, 설치 횟수에서 추측하는 것이 아니라 직접 읽은 것이므로 중요한 표현은 상상한 항목 이름이 아니라 원하는 효과입니다. 등급을 포함하지 않으며 등급 측정항목에 포함되지 않습니다. -
오프라인 계층을 제안하세요. 절대 조용히 활성화하지 마세요. 일회성 ~33MB 다운로드(
bge-small-en-v1.5의 양자화된 ONNX 빌드와 토크나이저, 고정된 리비전으로 고정됨)와 레지스트리의 카탈로그 벡터는 모두~/.hyperframes/에 캐시되며 프로젝트나 패키지에 추가되지 않습니다. 캐시되면 의미로 순위를 매기며 아무것도 전송되지 않습니다. 크기를 말하고 사용자가 결정하도록 한 다음, 동의하면--on-device를 전달하세요(-y로 프롬프트를 건너뜁니다). 대화형 제안은 TTY에서만 실행됩니다.--json에서는 프롬프트가 없지만 아무것도 찾지 못한 검색은warnings에 동일한 요청을 넣으므로 해당 배열을 읽고 사용자에게 결정을 맡기세요. 사용자가 다운로드가 무엇인지, 이 모델이 무엇인지, 또는 무엇이 머신을 떠나는지 물으면 https://hyperframes.heygen.com/developers/catalog-search를 참조하도록 안내하세요. -
에이전트 및 CI 호출에는
--json을 선호하세요. 서버 모드render,preview및play는 일반적인 JSON 출력을 제공하지 않습니다.preview --selection --json및preview --context --json은 쿼리 모드 예외입니다. -
doctor --json은 항상 0으로 종료됩니다. 페이로드에서 게이트합니다:npx hyperframes doctor --json | jq -e '.ok' >/dev/null -
비 TTY 모드는 자동이며 가운데 정렬 빈 프로젝트를 스캐폴딩합니다.
--example은 명명된 예제에서 시작할 때만 전달하세요. TTY에서 플래그 전용 모드를 강제하려면--non-interactive를 사용하세요. -
동일한 확인 루프의 모든 명령에 대해 하나의
HYPERFRAMES_RUN_ID를 사용하세요. -
해당 경고, 변수 또는 CI 조건이 렌더링을 게이트해야 하는 경우
--strict,--strict-all및--strict-variables를 사용하세요. -
JSON 경로는 홈 디렉토리를
$HOME으로 수정합니다. 수정을 역전시키려고 하지 마세요. -
호스팅된 클라우드 프로젝트가 200MB 업로드 제한에 근접하거나 초과하는 경우
cloud render --dry-run --json을 사용하고references/cloud.md에서.hyperframesignore조사를 따르세요. 크다고 해서 자산을 무시하지 마세요. -
검사가 통과했다고 렌더링하지 마세요. 최종 프리뷰에서 멈추고 승인을 기다리세요.
Studio 지시 편집
사용자가 "이 요소" 또는 현재 선택 항목을 언급하면 추측하는 대신 Studio를 쿼리하세요:
npx hyperframes preview --context --json --context-fields selection
가능하면 selection.target.hfId를 사용하고, 그렇지 않으면 선택자와 소스 파일을 사용하세요. 결과가 no-selection을 보고하면 사용자에게 요소를 클릭하고 다시 실행하도록 요청하세요. 필요한 컨텍스트 조각만 요청하세요. 계산된 스타일이나 편집 가능한 텍스트 메타데이터에만 --context-detail full을 사용하세요. 전체 동작 및 실패 코드는 references/preview-render.md에 있습니다.
렌더링 선택
| 필요 사항 | 명령어 |
|---|---|
| 빠른 로컬 반복 | npx hyperframes render --quality draft |
| 첫 번째 실제 인코딩 | npx hyperframes render --quality looks --output out.mp4 |
| 최종 로컬 전달 | npx hyperframes render --quality delivery --output out.mp4 |
| 재현 가능한 컨테이너 렌더링 | npx hyperframes render --docker --strict --output out.mp4 |
| 로컬 변수 기반 배치 렌더링 | npx hyperframes render --batch rows.json --output "renders/{name}.mp4" |
| HeyGen 호스팅 제로 인프라 렌더링 | npx hyperframes cloud render |
| 자체 관리 분산 AWS 렌더링 | npx hyperframes lambda render <project> --width 1920 --height 1080 --wait |
| 자체 관리 분산 GCP 렌더링 | npx hyperframes cloudrun render <project> --width 1920 --height 1080 --wait |
스킬 속성은 자동입니다 — 위의 예제는 --skill이 필요하지 않습니다. 워크플로우(hyperframes init --skill=<workflow>)로 스캐폴딩된 프로젝트는 hyperframes.json에 소유 스킬을 기록하고, 이후의 모든 렌더링은 익명 텔레메트리에서 이를 상속받습니다: 재렌더링, npm run render 및 --batch도 마찬가지입니다. 워크플로우를 통해 생성되지 않은 프로젝트에 스탬프를 찍으려면(첫 번째 렌더링이 유지됨) 명시적으로만 --skill=<slug>를 전달하세요.
사용자가 로컬 Chrome, FFmpeg 또는 AWS 없이 호스팅 렌더링을 원할 때 클라우드 렌더링을 사용하세요. AWS 소유권이 요구 사항인 경우에만 Lambda를 사용하세요. GCP 소유권이 요구 사항인 경우에만 Cloud Run을 사용하세요. 모든 클라우드 경로를 실행하기 전에 해당 참조를 읽으세요.
성공적인 렌더링을 확인한 후 텔레메트리가 비활성화되어 있거나 사용자가 거부하지 않는 한 하나의 피드백 보고서를 보내세요:
npx hyperframes feedback --rating <0-10> --comment "<구체적인 결과 또는 마찰점>"
깔끔한 실행 피드백은 간결하게 유지하세요. 버그나 마찰점의 경우 제출 전에 재현 패킷을 캡처하세요. 증상 요약만 보내지 마세요. 재현 가능한 명령어(프로젝트 디렉토리 기준 — 피드백은 공개 채널에 제출되므로 절대 절대 경로, 홈 디렉토리 접두사 또는 사용자/머신 식별자를 붙여넣지 마세요), 예상 동작과 실제 동작, 정확한 오류