Skip to content
Get started

allyhub frames

Pictures of a piece over time, drawn as the render draws them: every part's still on a sheet (default), a moment, a stretch tiled or as a clip, overlays; a sheet's cells, or a range of them; a doc's pages as they print, with how many; or any video file's frames

Terminal window
allyhub frames [item] [options]
Argument Type What it is
<item> string The piece (its id, its file without its extension, or its file; default the project’s only one), a sheet, a doc, or a video file: a path ending in .mp4, .mov, .webm, .m4v, .qt, .mkv or .avi is a file
Option Type Default What it does
--combo list of string The first combo matching name=value pairs joined with commas (lang=zh-cn,hook=b), or a combo’s id (c03); default the first combo
--range string A sheet’s: what to draw, a sheet (Summary), a range (Summary!B3:D9, or B3:D9 on the first sheet), columns (A:C) or rows (1:20); default its sheets, from A1
--page string A doc’s: the pages to draw large, counted from 1 (2, 2-4, 1,5); default every page, small, tiled
--at list of string Moments: seconds (from the start of –part when given) or anchors (@press, @/map a stretch’s end, @press+0.2); a video file’s are seconds. One is written as the frame itself, several are tiled. Without it, –part’s still, or every part’s still on one sheet
--part string The part –at, –from and –to count from; alone, its still
--from number A stretch of consecutive frames from this second (with –to), instead of –at
--to number The stretch’s last second
--clip string Write the stretch as a small silent video, .gif, .mp4 or .webm by its extension; with –out, the grid too
--overlay boolean false Draw over each tile the face boxes with ids, the person matte’s outline, the covered areas and the text boxes (a deck’s: each shape’s box and name, and the lines nearly in line); places nothing. Alone, over every part’s still
--beside string Another video file (a reference) whose frame at the same time goes on each tile’s left
--grid integer A video file at one –at: the frame at its own size with numbered lines every this many pixels
--out string Where the picture goes, always a WebP whatever the extension; default under .allyhub/work/frames/

--dir <value>: the project’s folder; default the one around where it is run. --json: print the result as JSON.

With --json, the command prints an object with these fields:

Field Type What it is
mode sheet, frame, grid, clip
Terminal window
allyhub frames launch/film
allyhub frames launch/film --at 2.5
allyhub frames launch/film --part hook --from 0 --to 1 --clip hook.gif
allyhub frames launch/film --at 1,2,3 --overlay
allyhub frames reference.mp4 --at 0,1,2
allyhub frames reference.mp4 --at 3 --grid 50
allyhub frames finance/budget --range 'Summary!A1:F20'
allyhub frames launch/plan
allyhub frames launch/plan --page 2-3

0 when it succeeds; the others are listed in Exit codes.

video: Making a video (one piece, or a batch of ads in combos)

check → frames → inspect → inspect layout → inspect timeline → inspect motion → inspect still → inspect contrast → inspect seams → inspect flash → inspect loop → inspect combos → audio → add search → add → dev → render

decks: Making a deck

slides capabilities → slides import → check → frames → frames compare → inspect layout → inspect contrast → dev → render

docs: Writing a doc

doc cover list → doc cover set → check → frames → inspect pages → dev → render

sheets: Making a sheet

sheet capabilities → sheet import → sheet calc → sheet trace → sheet diff → inspect sheet → sheet → frames → check → dev → render

images: Making an image: boards of Photoshop’s layers, a PSD in and out

image import → check → frames → inspect layout → inspect contrast → dev → render

x: Writing for X: a post, a thread, a long post or an article

check → inspect → frames → dev → render

references: Studying reference videos, and a piece against them

reference → reference compare → reference set → frames → frames compare → words → audio → align

Was this page helpful?