Agent Skills › heygen-com/hyperframes › hyperframes-cli

hyperframes-cli

GitHub

HyperFrames CLI 工具的使用指南,涵盖项目初始化、时间轴编辑、媒体处理、本地及云端渲染发布等全流程操作。

skills/hyperframes-cli/SKILL.md heygen-com/hyperframes

Trigger Scenarios

需要创建或初始化 HyperFrames 项目 需要编辑视频时间轴或添加关键帧 需要执行代码检查或 lint 验证 需要进行本地或云端视频渲染和预览 需要发布或分享 HyperFrames 作品

Install

npx skills add heygen-com/hyperframes --skill hyperframes-cli -g -y
More Options

Use without installing

npx skills use heygen-com/hyperframes@hyperframes-cli

指定 Agent (Claude Code)

npx skills add heygen-com/hyperframes --skill hyperframes-cli -a claude-code -g -y

安装 repo 全部 skill

npx skills add heygen-com/hyperframes --all -g -y

预览 repo 内 skill

npx skills add heygen-com/hyperframes --list

SKILL.md

Frontmatter
{
    "name": "hyperframes-cli",
    "description": "The HyperFrames CLI by job - scaffold, check, look at frames, edit the timeline, preview, render locally or in the cloud, publish, project history - plus reading its JSON and recovering from build or render failures."
}

Plugin installs: Before setup or freshness commands, follow plugin execution rules when this skill is inside a HyperFrames plugin.

HyperFrames CLI

Run npx hyperframes <command> unless the project gives a wrapper; then use the wrapper. It needs Node.js 22+ and FFmpeg. Every command has --help; most take --json, and a failure prints ✗ …, a Fix: line and exits non-zero.

Commands by job

Job Commands
Start init <dir> (blank; --example <name> only when asked), capture <url>
Read a project info, compositions, timeline --json, docs <topic>
Check it lint while writing; check --json as the gate (lint, runtime, layout, contrast)
Look at it snapshot (--at <t,…>, --range START,END, --composition <id>, --zoom, --angle, --against <video>), keyframes, compare, audio
Edit the timeline timeline with move, trim, split, set, duplicate, delete, apply, undo, ids
Reuse catalog, add (/hyperframes-registry)
Media and sound media-treatment, grade-compare, remove-background, tts, transcribe, beats, normalize-audio (/media-use)
Show and ship preview, present (/slideshow), render, publish, cloud, lambda, cloudrun
Desktop app open, catch-up
Upkeep doctor, browser, upgrade, skills, usage, clean, feedback

validate, inspect and layout are deprecated aliases of check; events is telemetry for skills' own scripts. Don't run them.

The loop

  1. Write, then npx hyperframes lint after the first pass and after structural changes.
  2. npx hyperframes check --json and fix every error. While a lint error remains the layout and contrast audits don't run; "0 samples" means nothing was checked. Contrast failures carry a suggestedColor. A finding at a single sample (an entrance in flight) is info; a 3 s+ video with no visible change fails sweep_static.
  3. npx hyperframes snapshot and read the PNGs (under .hyperframes/artifacts/snapshots/): that is how you see the video. With sub-compositions, snapshot a midpoint of every scene; tiny unstyled content or a missing hero is a mount defect (../hyperframes/references/format.md).
  4. npx hyperframes preview --background, check the URL answers 200, give the person the project URL and wait, unless they asked for the file or for no stops. Passing checks alone is not a reason to render.
  5. Time to render (step 4): npx hyperframes render --quality looks -o out.mp4 (draft while iterating, delivery for the final; paid plan: cloud render --fps <data-fps> --quality high -o out.mp4). Confirm the file is non-empty and its ffprobe duration matches the root data-duration, then look at decoded frames.

"This element" or the current selection: npx hyperframes preview --context --json --context-fields selection; no-selection means ask them to click it.

Edit the timeline

These are the edits Studio itself makes, so the result stays in Studio's shape.

  • timeline --json lists clips with absolute absStart/absEnd, owning file and the #id ref the edit commands take (timeline ids stamps missing ids).
  • timeline move|trim|split|set|duplicate|delete <ref> … --plan --json previews one edit; run it again without --plan. --start, --end, --duration set one edge or the length.
  • An edit is refused when the clip would overlap a neighbour (--overwrite, or move the neighbour first) or end past its composition: raise the root's data-duration first. No command changes data-duration.
  • Several edits at once: a JSON file such as [{"verb": "move", "ref": "#outro", "time": "9"}], then timeline apply plan.json --json. Each run prints a receipt; save it and timeline undo receipt.json reverts it.

Project history

Every write is kept and can be undone. At the start of a turn, npx hyperframes history begin --who <you> --label "<plan>", then history --since mine --who <you> to see what the person changed; build on their edits. A check failed or they say it got worse: history undo --who <you>, never hand-edit back. End the turn with history end.

Render where

Need Command
Local render --quality looks -o out.mp4 (draft, delivery)
Reproducible container render --docker --strict -o out.mp4
Batch from variables render --batch rows.json -o "renders/{name}.mp4"
Hosted, no local Chrome or FFmpeg cloud render (references/cloud.md)
Your own AWS or GCP lambda render, cloudrun render (references/lambda.md, references/cloudrun.md)

A 30 s film renders in a minute or two: run it in the foreground. Detach only a render longer than your tool's timeout (HYPERFRAMES_RENDER_DETACHED=1, its own group, output to a log) and wait with until grep -qE 'Render (complete|failed)' render.log; do sleep 5; done, never pgrep -f, which matches its own loop and waits until the tool times out.

After a verified render, send one feedback --rating, plus a report for anything the person asked for that HyperFrames can't do, unless telemetry is off: references/feedback.md.

When a command fails

Symptom Fix
Chrome missing or won't start npx hyperframes browser ensure; doctor --json always exits 0, gate on .ok
A heavy page isn't ready in time Raise --timeout on check or snapshot
Unusual codec looks blank Keep --proxy on (the default)
Render slow on Linux The summary's second line says screenshot + software gpu: the slow path
capture fails or writes BLOCKED.md Take nothing from its partial files; retry into a new -o folder
Disk tight clean --dry-run, then clean; never delete .hyperframes (it holds history)

References

Read the row before running its command.

Commands Read
init, capture, skills references/init-and-scaffold.md
lint, check, motion sidecars, snapshot references/lint-validate-inspect.md
compare, grade-compare, render --batch references/compare-and-batch.md
beats references/beats.md
preview, play, render, publish, Studio context references/preview-render.md
doctor, browser references/doctor-browser.md
auth, cloud, template variables references/cloud.md
lambda, cloudrun references/lambda.md, references/cloudrun.md
info, upgrade, compositions, timeline, docs, usage, telemetry references/upgrade-info-misc.md
--strict flags, run ids, clean, shader lint, JSON paths references/conventions.md
keyframes ../hyperframes/references/motion.md (Seeing motion)

Version History

  • 34a8d48 Current 2026-11-02 22:56

    新增付费计划的云端渲染支持,明确保留原始帧率和高质量设置;修复云渲染默认参数问题;重构技能结构并归档旧工作流。

  • 9566f96 2026-10-19 05:57

    新增插件安装规则说明;修复CLI对无速率窗口Claude计划的用量报告逻辑;优化快照文件夹清理及租约处理机制。

  • 627e947 2026-09-27 22:58

    新增 project history 功能,支持列出、撤销和恢复项目变更;修复了空闲超时、冲突处理及还原逻辑等缺陷。

  • a80d733 2026-09-22 11:12

    新增通过media-use引擎路由媒体搜索功能,优化资产查找流程;移除非交互式模式的旧有示例参数说明。

  • 097d901 2026-08-27 19:55

    优化 preview 命令的后台模式逻辑,使其在所有启动模式下均能正常运行;修复本地工作室模式下因 Vite 配置缺失导致的静默超时问题,增强稳定性。

  • 634df5a 2026-08-19 22:13

    新增查找运动原语步骤,引入强制性的创作者编辑交叉引用文档指引,优化媒体编辑渲染安全性。

  • 9d4c349 2026-07-24 22:17

Same Skill Collection

.agents/skills/changelog-video/SKILL.md
.claude/skills/changelog-video/SKILL.md
registry/blocks/canopy-part-title/SKILL.md
registry/blocks/code-slice-hero/SKILL.md
registry/blocks/cuboid-carousel/SKILL.md
registry/blocks/frost-sequence-camera-orbit/SKILL.md
registry/blocks/glass-shard-title/SKILL.md
registry/blocks/orbit-card/SKILL.md
registry/blocks/wireframe-portal-title/SKILL.md
skills/faceless-explainer/SKILL.md
skills/figma/SKILL.md
skills/general-video/SKILL.md
skills/hyperframes-core/SKILL.md
skills/hyperframes-creative/SKILL.md
skills/hyperframes-keyframes/SKILL.md
skills/hyperframes-registry/SKILL.md
skills/hyperframes/SKILL.md
skills/media-use/SKILL.md
skills/music-to-video/SKILL.md
skills/pr-to-video/SKILL.md
skills/product-launch-video/SKILL.md
skills/remotion-to-hyperframes/SKILL.md
skills/reverse-any-video/SKILL.md
skills/slideshow/SKILL.md
skills/talking-head-recut/SKILL.md
.agents/skills/captions-overlay/SKILL.md
.agents/skills/cut-the-curve/SKILL.md
.agents/skills/motion-doctrine/SKILL.md
.agents/skills/oversized-cursor/SKILL.md
.agents/skills/seam-craft/SKILL.md
.claude/skills/captions-overlay/SKILL.md
.claude/skills/cut-the-curve/SKILL.md
.claude/skills/motion-doctrine/SKILL.md
.claude/skills/oversized-cursor/SKILL.md
.claude/skills/seam-craft/SKILL.md
skills/embedded-captions/SKILL.md
skills/hyperframes-animation/SKILL.md
skills/hyperframes-audio/SKILL.md
skills/hyperframes-studio/SKILL.md
skills/motion-graphics/SKILL.md

Metadata

Files
0
Version
34a8d48
Hash
cfaa2a4d
Indexed
2026-07-24 22:17

inicio - Wiki
Copyright © 2011-2026 iteam. Current version is 2.155.2. UTC+08:00, 2026-11-03 01:14
浙ICP备14020137号-1