mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-05 05:37:09 +00:00
James RussoandClaude Opus 5.5
1c3fcf4d23
* docs(telemetry): say signed-in usage is linked to your account, not anonymous After hyperframes auth login the CLI sends a PostHog $identify with the account email (username as fallback) and merges the install's earlier anonymous usage; media-use does the same when it finds a signed-in account. Several places still called all telemetry anonymous. Say it is anonymous until you sign in, in the CLI reference (media-use, --skill, feedback, events, telemetry), the hyperframes-cli skill references, and the CLI help and notice strings. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * feat(telemetry): identify signed-in CLI users by their HyperFrames user id The CLI and media-use identified a signed-in install by account email, so CLI usage landed on a different PostHog person than the same account in the HyperFrames web app, which keys on toUUID(username). Identify by that same sha256-derived id instead, and $set email plus heygen_username on the person. heygen_username is the cross-project join column for the Snowflake event table (HeyGen's own project stores it as `name`). An account with no username still falls back to the lowercased email. Notices and docs now say usage is keyed on an id derived from the username with email and username stored on it. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * chore(telemetry): trim comments to the package's comment share Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * feat(telemetry): put heygen_username on every event while signed in The Snowflake event sync may not carry PostHog person properties, so a $set alone does not let an event row join across projects. The CLI now adds the signed-in HeyGen username (raw, from ~/.heygen/credentials) to every event and drops it once the credentials hold no user; media-use does the same on each event it sends. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * ci: count auth/paths.ts as an edit-accuracy bench input Telemetry now imports it to read the signed-in username. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * fix(telemetry): stat and read the credentials through one file handle CodeQL flagged the stat-then-read as a file system race. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * fix(telemetry): key signed-in events on the account id; fix stale anonymity copy Genesis review on #6703: - telemetry --help listed 'Any personally identifiable information' as never collected, and media-use's meta.md still said anonymous. - Installs already identified by email under an older CLI never merge into the new person, so send signed-in events with distinct_id = the account id (back to the install id after logout), in the CLI and in media-use, and stop claiming earlier usage always merges. - A user block with no credential no longer counts as signed in. - A UUID-shaped username passes through unhashed, as on the web. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
80 lines
6.2 KiB
Markdown
80 lines
6.2 KiB
Markdown
# init, capture, skills
|
||
|
||
<!-- registry-items: allow=blank,landscape-4k,portrait-4k,square-4k,media-use -->
|
||
|
||
Scaffolding commands. Use these instead of creating files by hand — they set up the right file structure, copy media, run transcription, and install AI coding skills.
|
||
|
||
## init
|
||
|
||
```bash
|
||
npx hyperframes init my-video # centered blank (TTY: wizard)
|
||
npx hyperframes init my-video --example warm-grain # pick an example
|
||
npx hyperframes init my-video --resolution portrait
|
||
npx hyperframes init my-video --video clip.mp4 # with video file
|
||
npx hyperframes init my-video --audio track.mp3 # with audio file
|
||
npx hyperframes init my-video --tailwind # Tailwind v4 browser runtime
|
||
npx hyperframes init my-video --non-interactive # CI — flag-only, same blank
|
||
```
|
||
|
||
**Default depends on TTY**: in a terminal, the CLI prompts for example/options (default: centered blank). Outside a TTY (CI, agents, piped output) it auto-switches to non-interactive and scaffolds that blank. Pass `--example` only to start from a named example. Pass `--non-interactive` to force flag-only mode on a TTY.
|
||
|
||
Templates: `blank`, `warm-grain`, `play-mode`, `swiss-grid`, `vignelli`, `decision-tree`, `kinetic-type`, `product-promo`, `nyt-graph`. (The closed set of `hyperframes:example` items in `registry/registry.json` plus the bundled `blank` template. `hyperframes catalog` does not list examples — its `--type` takes only `block` or `component` — so this list has no live equivalent and is checked by `bun run lint:skills`.)
|
||
|
||
Other useful flags:
|
||
|
||
- `--resolution` — preset: `landscape` (1920×1080), `portrait` (1080×1920), `landscape-4k`, `portrait-4k`, `square` (1080×1080), `square-4k`. Aliases: `1080p`, `4k`, `uhd`, `1080p-square`, `4k-square`.
|
||
- `--skill=<slug>` — record the owning skill (e.g. `hyperframes`) in `hyperframes.json`, so every later render of this project — re-renders, `npm run render`, `--batch` — is attributed to it on usage telemetry without re-passing the flag. You rarely pass it by hand.
|
||
- `--skip-skills` — leave AI coding skills alone: `init` does not install the core set. `HYPERFRAMES_SKIP_SKILLS=1` does the same.
|
||
- `--skip-transcribe` — don't auto-transcribe `--audio` / `--video` with Whisper.
|
||
- `--model`, `--language` — Whisper model / language for the auto-transcription.
|
||
|
||
**Tailwind** (`--tailwind`): the scaffold pins the Tailwind v4 browser runtime, not Studio's Tailwind v3 setup.
|
||
|
||
- Keep the pinned runtime; never swap in `cdn.tailwindcss.com`. Renders wait for `window.__tailwindReady` before frame 0. For offline or locked-down renders, compile to CSS and ship the stylesheet.
|
||
- Theme and custom utilities go in `<style type="text/tailwindcss">` with `@theme` and `@utility`. No v3 `@tailwind base/components/utilities`, no `tailwind.config.js`; `@config` and `@plugin` abort the browser compile.
|
||
- Write complete class tokens in the HTML. The runtime only sees classes it can scan, so never build a render-critical class name at seek time (`bg-${color}-500`); vary items through CSS variables (`style="--i: 2"`) or data variants.
|
||
- Tailwind is for static layout and style; timing stays in GSAP or another seekable runtime.
|
||
|
||
When `--audio` or `--video` is supplied, `init` transcribes the file with Whisper. For voice/model selection see the `media-use` skill.
|
||
|
||
## capture
|
||
|
||
```bash
|
||
npx hyperframes capture https://stripe.com # scaffold from a website
|
||
npx hyperframes capture https://linear.app -o linear-video # custom output directory
|
||
npx hyperframes capture https://example.com --json # JSON output for agents
|
||
npx hyperframes capture https://example.com --skip-assets # skip image/SVG download
|
||
npx hyperframes capture https://example.com --skip-vision # skip optional AI captions
|
||
npx hyperframes capture https://example.com --max-screenshots 12
|
||
npx hyperframes capture https://example.com --timeout 60000 # page-load timeout in ms
|
||
npx hyperframes capture https://example.com --capture-budget 90000 # post-navigation budget
|
||
HYPERFRAMES_CAPTURE_PROXY=http://127.0.0.1:3128 npx hyperframes capture https://example.com # behind an egress proxy
|
||
```
|
||
|
||
Captures a live URL as an editable HyperFrames project: screenshots become layered scenes, assets are downloaded locally, and the result is a normal project you can `lint` / `preview` / `render`. Use this when the user supplies a URL as the starting point for a video.
|
||
|
||
`--timeout` bounds page navigation; `--capture-budget` is the separate cooperative budget for work
|
||
after navigation (fonts, assets, vision, and contact sheets). The latter is not a hard wall-clock
|
||
watchdog and cannot interrupt native work already in flight. An outer caller deadline is therefore a
|
||
third, distinct timeout. An outer caller timeout leaves the capture result unknown; it does not prove
|
||
HyperFrames hung or that the navigation timeout should be increased. Preserve the last phase and
|
||
classify the boundary that fired. `--skip-vision` disables only optional AI image captioning.
|
||
|
||
For agents, use `--json`. The result includes `ok`, warnings, and `lastPhase`. The command also emits
|
||
stable `HYPERFRAMES_CAPTURE_PHASE` records so a watchdog can report the last started, completed, or
|
||
degraded phase without retaining sensitive payloads.
|
||
|
||
Treat a non-zero exit, JSON `ok: false`, or an output `BLOCKED.md` as a **hard stop**. Do not render,
|
||
build, or infer brand/design data from partial files in a blocked capture. A successful capture may
|
||
degrade an optional phase within budget, but its structural output still has to be usable. Exit zero and file existence alone are not semantic success: require the current
|
||
invocation's JSON `ok: true`, no `BLOCKED.md`, and artifacts usable for the video. Run each retry
|
||
into a fresh output directory; never merge or reuse a blocked attempt's partial output.
|
||
|
||
## skills
|
||
|
||
```bash
|
||
npx hyperframes skills # install HyperFrames skills for AI coding tools
|
||
```
|
||
|
||
One-time setup that adds the HyperFrames skill pack (/hyperframes with its references, /hyperframes-cli, /hyperframes-registry, /media-use, /figma, /slideshow, /remotion-to-hyperframes) to the local AI coding environment so agents follow the framework conventions. Re-run after major HyperFrames upgrades.
|