# 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

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

## Usage

```bash
allyhub frames [item] [options]
```

## Arguments

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

## Options

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

## 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 |
| --- | --- | --- |
| `mode` | `sheet`, `frame`, `grid`, `clip` |  |

## Examples

```bash
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
```

## 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` → [`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`](https://allyhub.com/docs/reference/cli/render.md)

**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` → [`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`](https://allyhub.com/docs/reference/cli/render.md)

**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` → [`inspect pages`](https://allyhub.com/docs/reference/cli/inspect-pages.md) → [`dev`](https://allyhub.com/docs/reference/cli/dev.md) → [`render`](https://allyhub.com/docs/reference/cli/render.md)

**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` → [`check`](https://allyhub.com/docs/reference/cli/check.md) → [`dev`](https://allyhub.com/docs/reference/cli/dev.md) → [`render`](https://allyhub.com/docs/reference/cli/render.md)

**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` → [`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`](https://allyhub.com/docs/reference/cli/render.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` → [`dev`](https://allyhub.com/docs/reference/cli/dev.md) → [`render`](https://allyhub.com/docs/reference/cli/render.md)

**references**: Studying reference videos, and a piece against them

[`reference`](https://allyhub.com/docs/reference/cli/reference.md) → [`reference compare`](https://allyhub.com/docs/reference/cli/reference-compare.md) → [`reference set`](https://allyhub.com/docs/reference/cli/reference-set.md) → `frames` → [`frames compare`](https://allyhub.com/docs/reference/cli/frames-compare.md) → [`words`](https://allyhub.com/docs/reference/cli/words.md) → [`audio`](https://allyhub.com/docs/reference/cli/audio.md) → [`align`](https://allyhub.com/docs/reference/cli/align.md)
