allyhub render
The files: a video, its frames, subtitles, cover and mastered mix; a batch's table of ads; a deck's PDF, PPTX and PNGs; a doc's PDF and Markdown; a sheet's Excel workbook with live formulas, PDF, PNG, CSV, Markdown and JSON; an image's pictures, PDF and layered PSDs; a 3D model's GLB
allyhub render [items…] [options]Arguments
Section titled “Arguments”| Argument | Type | What it is |
|---|---|---|
<items> |
list of string | Only these items: each an id (its file without its extension) or its file, or a folder of items; default every one |
Options
Section titled “Options”| Option | Type | Default | What it does |
|---|---|---|---|
--combo |
list of string | Only the combos matching name=value pairs joined with commas (lang=zh-cn,hook=b), or a combo’s id (c03) | |
--type |
list of string | File types: mp4, mov, webm, gif, png, srt, vtt (cues cut as the piece’s captions layer cuts them, else by default), cover, wav (the mix, mastered as the render masters it: 48 kHz, 16 bits, the film’s length), pdf, pptx; csv for a piece with slots, its table of ads (<piece>.ads.csv: a row per ad with its combo, picks, length, file, name and generated media); a doc’s pdf, docx, png, md; a sheet’s xlsx (every sheet, formulas live with their values cached), pdf, png, csv, md, json; an image’s png, jpeg, webp, avif (a file a board), pdf, zip and psd (a layered Photoshop file a board: each layer of its kind, its pixels drawn by Chrome); a 3D model’s glb. Default mp4 for a video, pdf for a deck and a doc, xlsx for a sheet, png for an image, glb for a model; a type an item does not have is skipped | |
--out |
string | The folder the files go in; default .allyhub/out | |
--name |
string | Name a video’s or deck’s files <name>.<ext> in its folder of the output, with what tells its versions apart before the extension when there are several (<name>.zh-cn.mp4, <name>.c03.mp4); default <output>.<combo>.<ext> |
Parameters
Section titled “Parameters”Each is given as --param name=value.
| Name | Type | Default | What it does |
|---|---|---|---|
codec |
h264, h265 |
"h264" |
The mp4’s video codec; h265 is smaller |
crf |
integer | Quality, lower is better: default 20 for an mp4, ready to share, 30 for a webm | |
max-bitrate |
integer | An mp4’s most video bitrate, kbit/s, 0 for none: default 8000 at 1080p 30 fps, scaled by the frame’s pixels and the frames a second (16000 at 1080p 60, 32000 at 4K 30), so the file is ready to share | |
audio-bitrate |
integer | The sound’s bitrate, kbit/s: default 192 (AAC in an mp4), 160 (Opus in a webm); a mov keeps PCM | |
steps |
boolean | false |
A deck’s pdf, png and pptx: a page, a file or a slide per step of each page, not only its last |
values |
data, shown |
A sheet’s csv, json and md: each value as data (a date 2026-01-15, a time 09:30, a duration 36:00, a number to 15 digits; csv’s and json’s default) or as its format shows it (15 Jan 2026, $1,200.00; md’s default) | |
bom |
boolean | true |
A sheet’s csv starts with a UTF-8 byte-order mark, by which Excel reads its letters right (é, €, 中文); false for a tool that does not expect one |
quality |
integer | An image’s jpeg, webp and avif, 0–100: default 90 for a jpeg, 60 for an avif, a webp lossless | |
scale |
number | An image’s png, jpeg, webp, avif and zip: each board’s picture this many times its size, its layout kept (type and shapes drawn sharp, a picture as many pixels as its file has); default 1 | |
width |
integer | An image’s pictures each this many pixels wide, the height in proportion: a scale for each board | |
height |
integer | An image’s pictures each this many pixels high, the width in proportion: a scale for each board | |
max-kb |
number | An image’s jpeg, webp and avif: each board’s file at most this many KB, at the best quality under it (said); a png over it is not made | |
psd |
psd, psb |
"psd" |
An image’s psd: psd, or psb (Photoshop’s large document format); a board is at most 16384 pixels a side, which a psd holds |
pptx |
native, picture |
"native" |
A deck’s pptx: native, PowerPoint’s own model, editable there (the deck’s masters, layouts, placeholders, shapes, text, pictures, videos and notes, a component as its picture); or picture, each slide a picture of the page |
Global options
Section titled “Global options”--dir <value>: the project’s folder; default the one around where it is run. --json: print the result as JSON.
Output
Section titled “Output”With --json, the command prints an object with these fields:
| Field | Type | What it is |
|---|---|---|
out |
string | |
files |
list of object | |
failed |
list of object |
Examples
Section titled “Examples”allyhub renderallyhub render launch/film --type mp4,srtallyhub render launch/film --type wavallyhub render ads/tidyform --type csvallyhub render launch/plan --type pdf,mdallyhub render finance/budget --type xlsx,pdfallyhub render finance/budget --type csv --param bom=falseallyhub render launch/deck --type pptx --param pptx=pictureallyhub render launch/poster --type psdallyhub render launch/poster --type jpeg --param scale=2 --param max-kb=2000allyhub render --combo lang=zh-cn --param crf=16allyhub render launch/film --name launch-film --param max-bitrate=0Exit codes
Section titled “Exit codes”0 when it succeeds; the others are listed in Exit codes.
In the work
Section titled “In the work”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
footage: Cutting recorded footage: a talking head, an interview
words → words edits → align → frames cuts → audio recording → 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
websites: Making a website: any web project, with its website JSON listed in allyhub.yaml
check → render → frames web → frames compare → site deploy → site status → site live
x: Writing for X: a post, a thread, a long post or an article