# 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

Source: https://allyhub.com/docs/reference/cli/render · AllyHub 0.10.0
Index of all docs: https://allyhub.com/llms.txt

## Usage

```bash
allyhub render [items…] [options]
```

## 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

| 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 (&lt;piece&gt;.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 &lt;name&gt;.&lt;ext&gt; in its folder of the output, with what tells its versions apart before the extension when there are several (&lt;name&gt;.zh-cn.mp4, &lt;name&gt;.c03.mp4); default &lt;output&gt;.&lt;combo&gt;.&lt;ext&gt; |

## 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

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

## 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

```bash
allyhub render
allyhub render launch/film --type mp4,srt
allyhub render launch/film --type wav
allyhub render ads/tidyform --type csv
allyhub render launch/plan --type pdf,md
allyhub render finance/budget --type xlsx,pdf
allyhub render finance/budget --type csv --param bom=false
allyhub render launch/deck --type pptx --param pptx=picture
allyhub render launch/poster --type psd
allyhub render launch/poster --type jpeg --param scale=2 --param max-kb=2000
allyhub render --combo lang=zh-cn --param crf=16
allyhub render launch/film --name launch-film --param max-bitrate=0
```

## Exit codes

`0` when it succeeds; the others are listed in [Exit codes](https://allyhub.com/docs/reference/cli/exit-codes.md).

## In the work

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

[`check`](https://allyhub.com/docs/reference/cli/check.md) → [`frames`](https://allyhub.com/docs/reference/cli/frames.md) → [`inspect`](https://allyhub.com/docs/reference/cli/inspect.md) → [`inspect layout`](https://allyhub.com/docs/reference/cli/inspect-layout.md) → [`inspect timeline`](https://allyhub.com/docs/reference/cli/inspect-timeline.md) → [`inspect motion`](https://allyhub.com/docs/reference/cli/inspect-motion.md) → [`inspect still`](https://allyhub.com/docs/reference/cli/inspect-still.md) → [`inspect contrast`](https://allyhub.com/docs/reference/cli/inspect-contrast.md) → [`inspect seams`](https://allyhub.com/docs/reference/cli/inspect-seams.md) → [`inspect flash`](https://allyhub.com/docs/reference/cli/inspect-flash.md) → [`inspect loop`](https://allyhub.com/docs/reference/cli/inspect-loop.md) → [`inspect combos`](https://allyhub.com/docs/reference/cli/inspect-combos.md) → [`audio`](https://allyhub.com/docs/reference/cli/audio.md) → [`add search`](https://allyhub.com/docs/reference/cli/add-search.md) → [`add`](https://allyhub.com/docs/reference/cli/add.md) → [`dev`](https://allyhub.com/docs/reference/cli/dev.md) → `render`

**footage**: Cutting recorded footage: a talking head, an interview

[`words`](https://allyhub.com/docs/reference/cli/words.md) → [`words edits`](https://allyhub.com/docs/reference/cli/words-edits.md) → [`align`](https://allyhub.com/docs/reference/cli/align.md) → [`frames cuts`](https://allyhub.com/docs/reference/cli/frames-cuts.md) → [`audio recording`](https://allyhub.com/docs/reference/cli/audio-recording.md) → `render`

**decks**: Making a deck

[`slides capabilities`](https://allyhub.com/docs/reference/cli/slides-capabilities.md) → [`slides import`](https://allyhub.com/docs/reference/cli/slides-import.md) → [`check`](https://allyhub.com/docs/reference/cli/check.md) → [`frames`](https://allyhub.com/docs/reference/cli/frames.md) → [`frames compare`](https://allyhub.com/docs/reference/cli/frames-compare.md) → [`inspect layout`](https://allyhub.com/docs/reference/cli/inspect-layout.md) → [`inspect contrast`](https://allyhub.com/docs/reference/cli/inspect-contrast.md) → [`dev`](https://allyhub.com/docs/reference/cli/dev.md) → `render`

**docs**: Writing a doc

[`doc cover list`](https://allyhub.com/docs/reference/cli/doc-cover-list.md) → [`doc cover set`](https://allyhub.com/docs/reference/cli/doc-cover-set.md) → [`check`](https://allyhub.com/docs/reference/cli/check.md) → [`frames`](https://allyhub.com/docs/reference/cli/frames.md) → [`inspect pages`](https://allyhub.com/docs/reference/cli/inspect-pages.md) → [`dev`](https://allyhub.com/docs/reference/cli/dev.md) → `render`

**sheets**: Making a sheet

[`sheet capabilities`](https://allyhub.com/docs/reference/cli/sheet-capabilities.md) → [`sheet import`](https://allyhub.com/docs/reference/cli/sheet-import.md) → [`sheet calc`](https://allyhub.com/docs/reference/cli/sheet-calc.md) → [`sheet trace`](https://allyhub.com/docs/reference/cli/sheet-trace.md) → [`sheet diff`](https://allyhub.com/docs/reference/cli/sheet-diff.md) → [`inspect sheet`](https://allyhub.com/docs/reference/cli/inspect-sheet.md) → [`sheet`](https://allyhub.com/docs/reference/cli/sheet.md) → [`frames`](https://allyhub.com/docs/reference/cli/frames.md) → [`check`](https://allyhub.com/docs/reference/cli/check.md) → [`dev`](https://allyhub.com/docs/reference/cli/dev.md) → `render`

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

[`image import`](https://allyhub.com/docs/reference/cli/image-import.md) → [`check`](https://allyhub.com/docs/reference/cli/check.md) → [`frames`](https://allyhub.com/docs/reference/cli/frames.md) → [`inspect layout`](https://allyhub.com/docs/reference/cli/inspect-layout.md) → [`inspect contrast`](https://allyhub.com/docs/reference/cli/inspect-contrast.md) → [`dev`](https://allyhub.com/docs/reference/cli/dev.md) → `render`

**websites**: Making a website: any web project, with its website JSON listed in allyhub.yaml

[`check`](https://allyhub.com/docs/reference/cli/check.md) → `render` → [`frames web`](https://allyhub.com/docs/reference/cli/frames-web.md) → [`frames compare`](https://allyhub.com/docs/reference/cli/frames-compare.md) → [`site deploy`](https://allyhub.com/docs/reference/cli/site-deploy.md) → [`site status`](https://allyhub.com/docs/reference/cli/site-status.md) → [`site live`](https://allyhub.com/docs/reference/cli/site-live.md)

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

[`check`](https://allyhub.com/docs/reference/cli/check.md) → [`inspect`](https://allyhub.com/docs/reference/cli/inspect.md) → [`frames`](https://allyhub.com/docs/reference/cli/frames.md) → [`dev`](https://allyhub.com/docs/reference/cli/dev.md) → `render`
