Skills › HyperFrames › hyperframes-cli › beats.md

beats.md

17 lines · skills/hyperframes-cli/references/beats.md at a595755

Names a skill

Most marks come from matching words in the file, so treat them as pointers.

1# Generate a project beat grid

3Use `hyperframes beats` when an existing HyperFrames project needs the Studio-compatible beat file for its music track. This is a CLI utility, not a complete video workflow.

5```bash

6npx hyperframes beats

7npx hyperframes beats ./my-video

8npx hyperframes beats ./my-video --json

9```

11Given an audio or video file instead of a folder (`npx hyperframes beats music.mp3 --json`), `beats` analyses that file and prints `{ ok, file, count, bpm, beatTimes }`; it writes nothing.

13The project must contain a local music `<audio>` source. Mark it with `data-timeline-role="music"`; an id containing `music`, `bgm`, or `soundtrack` is also recognized. The command decodes that file with ffmpeg, tracks its beats, and writes `beats/<audio-relative-path>.json`.

15If the track has no steady beat, the command fails and writes nothing. If ffmpeg is missing, run `npx hyperframes doctor`.

17For a whole video cut to a music track, see `/hyperframes` → `references/film.md`.

Generate a project beat grid

Use hyperframes beats when an existing HyperFrames project needs the Studio-compatible beat file for its music track. This is a CLI utility, not a complete video workflow.

npx hyperframes beats
npx hyperframes beats ./my-video
npx hyperframes beats ./my-video --json

Given an audio or video file instead of a folder (npx hyperframes beats music.mp3 --json), beats analyses that file and prints { ok, file, count, bpm, beatTimes }; it writes nothing.

The project must contain a local music <audio> source. Mark it with data-timeline-role="music"; an id containing music, bgm, or soundtrack is also recognized. The command decodes that file with ffmpeg, tracks its beats, and writes beats/<audio-relative-path>.json.

If the track has no steady beat, the command fails and writes nothing. If ffmpeg is missing, run npx hyperframes doctor.

For a whole video cut to a music track, see /hyperframes → references/film.md.

Raw lines 1 to 17

Names a skill hyperframes :17