HyperFrames CLI
모든 명령어는 npx hyperframes를 통해 실행됩니다(프로젝트에 로컬 래퍼가 지정된 경우는 제외). 로컬 래퍼를 정확히 따르십시오. Node.js >= 22와 FFmpeg가 필요합니다.
워크플로우
- 스캐폴딩 —
npx hyperframes init my-video(또는 URL에서capture) - 작성 — HTML 컴포지션 작성 (
hyperframes-core스킬 참고) - 린트 —
npx hyperframes lint - 검증 —
npx hyperframes validate(런타임 오류 + 대비) - 시각적 검사 —
npx hyperframes inspect - 프리뷰 —
npx hyperframes preview - 렌더링 — 다음 변형 중 선택:
- 반복:
npx hyperframes render --quality draft - 최종:
npx hyperframes render --quality high --output out.mp4 - CI / 교차 호스트 재현:
npx hyperframes render --docker --strict --output out.mp4 - 클라우드 (장시간 / 대규모):
npx hyperframes lambda render ./my-project --width 1920 --height 1080 --wait(아래 Lambda 참고)
- 반복:
프리뷰 전에 lint, validate, inspect를 실행하세요. lint는 누락된 data-composition-id, 중복 트랙, 등록되지 않은 타임라인을 찾아냅니다. validate는 Headless Chrome에서 컴포지션을 로드하여 런타임 콘솔 오류와 WCAG 대비 문제를 보고합니다. inspect는 타임라인을 탐색하며 텍스트가 버블/컨테이너 또는 캔버스 밖으로 흘러나오는지 보고하고, *.motion.json 사이드카 파일이 있는 경우 동일하게 탐색된 타임라인에 대해 모션 의도(탐색 시 발동되는 진입 효과, 스태거 순서, 프레임 내 위치, 활성 상태)를 검증합니다.
모션이 많은 작업에서는 스냅샷 기반 반복과 *.motion.json 사이드카를 선호합니다. 자세한 규율 및 모션 검증 사양은 references/lint-validate-inspect.md를 참조하세요.
에이전트 규약
모든 명령어에 적용되는 횡단 규칙:
--json은render,preview,play를 제외한 모든 명령어에서 사용 가능합니다. 지원되는 명령어의 에이전트/CI 호출에 사용하세요. 출력에는_meta봉투(CLI 버전, 최신 버전, 업데이트 권장 사항)가 포함됩니다.render는 stdout + 종료 코드를 통해서만 상태를 보고합니다. 아래의 사후 렌더링 확인으로 성공 여부를 검증하세요.preview/play는 서버이므로 JSON을 지원하지 않습니다.doctor --json은 환경이 손상된 경우에도 항상 0으로 종료됩니다. 페이로드의ok필드를 확인하세요:npx hyperframes doctor --json | jq -e '.ok' > /dev/null. 이렇게 하면 파이프라인이 CLI 릴리스 변경으로부터 격리됩니다.- 비-TTY 모드는 자동 감지됩니다. stdout이 TTY가 아닌 경우(CI, 에이전트, 파이프 출력) CLI는 자동으로 비대화형 모드로 전환됩니다. 이때
init실행 시--example이 필수입니다. TTY에서도 이 모드를 강제하려면--non-interactive를 전달하세요. - 렌더링 CI 게이팅:
--strict는 린트 오류가 있을 때 실패하고,--strict-all은 경고에서도 실패하며,--strict-variables는 선언되지 않은--variables키가 있을 때 실패합니다. --json의 경로는 수정됩니다.$HOME은 리터럴$HOME이 되어 출력물을 버그 리포트 및 에이전트 컨텍스트에 안전하게 붙여넣을 수 있습니다.- 렌더링 후 검증.
render가 0으로 종료된 후, 성공을 보고하기 전에 출력 파일이 존재하고 적절한 크기인지 확인하세요:[ -s "$OUTPUT" ] || echo "render에서 출력이 생성되지 않았습니다". CLI는 성공 시◇ <path>를 출력합니다. 장시간 렌더링의 경우ffprobe -i "$OUTPUT" -show_format -v error로 재생 시간도 확인하는 것이 좋습니다.
라우팅
| 원하는 작업 | 읽어야 할 문서 |
|---|---|
프로젝트 스캐폴딩 (init, capture, skills) | references/init-and-scaffold.md |
정확성 확인 (lint, validate, inspect, snapshot) | references/lint-validate-inspect.md |
프리뷰 또는 렌더링 (preview, play, render, publish) | references/preview-render.md |
환경 진단 (doctor, browser) | references/doctor-browser.md |
AWS Lambda 클라우드 렌더링 (lambda deploy / sites / render / progress / destroy / policies) | references/lambda.md |
기타 명령어 (info, upgrade, compositions, docs, benchmark, telemetry, 애셋 전처리) | references/upgrade-info-misc.md |
스킬 간 연계
- Tailwind 프로젝트 (
init --tailwind) → 클래스나 테마 토큰을 수정하기 전에hyperframes-core(Tailwind 참고)를 사용하세요. - 레지스트리 블록/컴포넌트 (
hyperframes add,hyperframes catalog) → 설치 경로, 하위 컴포지션 연결, 스니펫 병합을 위해hyperframes-registry를 사용하세요. - 애셋 전처리 (
tts,transcribe,remove-background) → 음성 선택, Whisper 모델 규칙, 캡션, TTS-캡션 체인을 위해hyperframes-media를 사용하세요. - 파라미터화된 렌더링 (
--variables) →<html>에data-composition-variables로 선언하며, 전체 스키마는hyperframes-core를 참조하세요.
Lambda (클라우드 렌더링)
hyperframes lambda는 AWS Lambda에 분산 렌더링을 배포하고 노트북 또는 CI에서 렌더를 실행합니다. 전체 과정은 세 명령어로 이루어집니다:
npx hyperframes lambda deploy # SAM 스택 프로비저닝 (Lambda + Step Functions + S3)
npx hyperframes lambda render ./my-project --width 1920 --height 1080 --wait
npx hyperframes lambda destroy # 리소스 정리 (S3 버킷은 유지됨)
렌더 시간이 너무 길거나(여러 분 분량의 비디오) 파일이 너무 크거나(4K) 대규모 병렬 배치를 처리해야 하며 AWS 자격 증명이 설정된 경우 Lambda를 사용하세요. 개발 루프 반복은 로컬 render를 사용하세요.
전제 조건, 6개의 하위 명령어(deploy, sites create, render, progress, destroy, policies), IAM 정책 검증, 상태 파일, 비용/정리 규칙은 references/lambda.md를 참조하세요.
최소 완료 게이트
정적 게이트
npx hyperframes lint
npx hyperframes validate
레이아웃에 민감한 작업의 경우 inspect를 추가하고, CI에서 린트 오류 시 실패하도록 render --strict를 사용하세요.
시각적 스모크 테스트 — 프로젝트가 하위 컴포지션을 사용하는 경우 필수
lint / validate / inspect는 각 컴포지션을 독립적으로 평가합니다. index.html을 로드하고 data-composition-src를 통해 하위 컴포지션을 마운트하지 않으므로, 파일 간 마운트 실패를 감지할 수 없습니다 (hyperframes-core → references/sub-compositions.md, "일반적인 문제점" 참고). 이를 감지하는 유일한 게이트는 실제로 index.html을 로드하고 타임라인을 탐색하는 것입니다.
hyperframes snapshot을 사용하세요. 이 명령어는 render와 동일한 방식으로 프로젝트를 로드하므로 동일한 마운트 경로를 실행하지만, 요청한 타임스탬프만 캡처하므로 전체 렌더링 대신 몇 초 만에 완료됩니다:
# 각 하위 컴포지션의 중간 지점에서 한 프레임 캡처.
# 중간 지점 = index.html의 각 호스트 슬롯에 대한 data-start + data-duration/2
npx hyperframes snapshot --at <t1>,<t2>,<t3>,...
# 또는 장면별 타겟팅이 필요하지 않은 경우, 균등 간격 샘플:
npx hyperframes snapshot --frames 9
출력은 snapshots/frame-NN-at-Xs.png에 저장됩니다. 각 프레임을 장면 계획과 대조하여 확인하세요.
프레임별 위험 신호 (각각 정적 게이트가 놓치는 특정 실패 모드와 매핑됨):
| 보이는 현상 | 근본 원인 |
|---|---|
| 텍스트가 왼쪽 상단에 아주 작게 스타일 없이 표시됨 | <style> 블록이 <template> 밖 <head>에 남아 있음 (문제점 1) — CSS가 라이브 DOM에 도달하지 않음 |
| SVG/아이콘 요소가 캔버스 크기로 확대됨 | 위와 동일 — 너비/높이 제약이 적용되지 않음 |
| 장면의 핵심 요소가 완전히 사라지고 배경 + 워터마크만 보임 | Host-id ≠ 템플릿 id (문제점 2) — 타임라인이 실행되지 않아 초기 상태의 프레임이 캡처됨 |
스냅샷 명령어 로그에 Sub-composition timelines not registered after 45000ms 메시지 출력 | 문제점 2 — 직접 확인 |
snapshots/는 시각 확인 후 삭제해도 됩니다. 최종 사용자 대상 렌더링은 npx hyperframes render로 별도로 실행합니다.