hyperframes-cli
由 heygen-com 提供的 hyperframes-cli Skill,包含安装方法、功能说明、完整指令和 GitHub 原文入口。
name: hyperframes-cli description: HyperFrames CLI - scaffold, check frames, edit timelines, preview, render, share and project history; read JSON and recover from failures.
功能说明
HyperFrames CLI - scaffold, check frames, edit timelines, preview, render, share and project history; read JSON and recover from failures.
快速安装
npx skills add https://github.com/heygen-com/hyperframes --skill hyperframes-cli
交给 AI 助手使用
以下是页面提示词的中文转述,命令保持原样。
运行 npx skills use "https://github.com/heygen-com/hyperframes" --skill "hyperframes-cli",完整阅读输出并按 Skill 说明操作。必要时先将输出保存到临时文件;相对路径以输出提供的支持文件目录为准。
Plugin installs: Inside a HyperFrames plugin, follow plugin execution rules.
Usage beacon: run npx hyperframes events --skill=hyperframes-cli 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 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.
A --json result may carry _meta.updateNotice: a newer HyperFrames release is out. Pass it to the person once per conversation, in your own words, at a natural pause; updating is theirs to decide.
Commands by job
| Job | Commands |
|---|---|
| Start | init <dir> --skip-skills (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, share, publish (legacy), cloud, lambda, cloudrun |
| Desktop app | open, catch-up |
| Upkeep | doctor, browser, upgrade, usage, clean, feedback |
captions is not a command: run transcribe, then read ../hyperframes/references/captions.md.
validate, inspect and layout are deprecated aliases of check; events is skills' own telemetry. Don't run them.
The loop
- Write, then
npx hyperframes lintafter the first pass and after structural changes. npx hyperframes check --jsonand 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 asuggestedColor. A finding at a single sample (an entrance in flight) is info; a 3 s+ video with no visible change failssweep_static.npx hyperframes snapshotand 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).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.- Time to render (step 4):
npx hyperframes render --quality looks -o out.mp4(draftwhile iterating,deliveryfor the final; paid plan:cloud render --fps <data-fps> --quality high -o out.mp4). Confirm the file is non-empty and itsffprobeduration matches the rootdata-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 --jsonlists clips with absoluteabsStart/absEnd, owningfileand the#idref the edit commands take (timeline idsstamps missing ids).timeline move|trim|split|set|duplicate|delete <ref> … --plan --jsonpreviews one edit; run it again without--plan.--start,--end,--durationset 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'sdata-durationfirst. No command changesdata-duration. - Several edits at once: a JSON file such as
[{"verb": "move", "ref": "#outro", "time": "9"}], thentimeline apply plan.json --json. Each run prints areceipt; save it andtimeline undo receipt.jsonreverts 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, share, publish (legacy), 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) |
来源与许可
heygen-com/hyperframes 提供此 Skill,适用 Apache-2.0。本版本追加了安装和访问入口,并将相对文档链接解析为 GitHub 地址;原始文件可从下方原文入口获取。
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to the Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by the Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding any notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
Copyright 2026 HeyGen, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.