Skip to content
Get started

The allyhub CLI

Every command of the allyhub command line, by the work it serves, with its options, output and examples.

Run any command with npx allyhub in a project, or npx -y allyhub@latest anywhere else. allyhub help <command> prints the same facts as these pages, for the version installed.

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

Section titled “Making a video (one piece, or a batch of ads in combos)”

allyhub help video

Command What it does
allyhub check Problems: objective errors in the project’s items, by rule; exits 1 when one must be fixed
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
allyhub inspect The check’s facts, for you to judge, never problems: by kind, part and time
allyhub inspect layout One version’s layout measured now, at its measured moments or at –at / –every; –texts lists every text block with its fonts
allyhub inspect timeline One version’s timeline, drawn nowhere: each part’s stretch, layers and their stacking, speech, anchors, room tone, transitions, sound effects, music, generated media
allyhub inspect motion Follow everything on screen frame by frame and list each thing’s largest step, a move or a fade
allyhub inspect still The stretches where a video’s picture holds, measured now
allyhub inspect contrast The text against the pixels behind its glyphs now, as WCAG contrast ratios (the check does not measure it)
allyhub inspect seams A video’s joins measured now, the picture’s own shift too
allyhub inspect flash Every frame of a video against the frames beside it, now
allyhub inspect loop A video’s last frame against its first, and two frames in a row at each end for scale
allyhub inspect combos A batch’s matrix, read without a browser: its slots, rules, the combos chosen and why, the render’s cost
allyhub audio How a video sounds: its mix’s loudness, what the master did, silences, onsets against cuts and cues, pace, levels under and between the words, each part’s speech and voice; or a file on its clock, or a file alone
allyhub add search Finds the starter components, AllyHub’s resources (models, sceneries) and Poly Haven’s CC0 models, HDRIs and textures whose names, tags, categories or descriptions hold every word, each with where its words were found; with no words, lists every one
allyhub add Adds to the project what AllyHub and Poly Haven have, each named <type>/<name>: a starter component, a 3D model, a 3D scenery, a skill or a template from AllyHub’s registry, or a CC0 model, HDRI or texture from Poly Haven; alone it lists everything AllyHub has, by type
allyhub dev The project’s items in the browser, each in its editor (docs, sheets, videos, 3D sceneries; websites listed), as their files change; runs until stopped, and run again while it runs, opens its page and ends
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

Cutting recorded footage: a talking head, an interview

Section titled “Cutting recorded footage: a talking head, an interview”

allyhub help footage

Command What it does
allyhub words A recording’s words: heard on this computer when it has none (or –fresh), printed by word index with the sounds between them; a stretch by seconds, heard again with –fresh
allyhub words edits What a cut list keeps of a recording: the stretches kept, every word and sound removed, the room tone at its ends, and every join measured on both sides
allyhub align The offset between recordings of the same moment, from their sound, with how sharply they match and how it drifts
allyhub frames cuts A review sheet per cut of a video (a cut take’s jumps, part joins, a scenery camera’s cuts): frames around it, waveform and level, the words each side, the sound at it
allyhub audio recording How a video’s voice is recorded: its speech as its mic settings record it (the room, the room tone, the spectrum, the dynamics), a file’s beside it with the differences, and the video’s setting fitted to the file; or a file alone
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 help decks

Command What it does
allyhub slides capabilities What a deck’s API holds of python-pptx’s (its classes and enums), how it differs and what it adds, as JSON
allyhub slides import Makes a deck of a PowerPoint file: its masters and layouts as the deck’s module, its slides and its words and notes as the files the module names, its pictures and videos beside them, listed in allyhub.yaml; says what it could not hold; never over a file that is there
allyhub check Problems: objective errors in the project’s items, by rule; exits 1 when one must be fixed
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
allyhub frames compare How a candidate picture differs from a reference, as numbers (ΔE, channels, SSIM, levels, grain, edges, regions) with a heatmap and a side-by-side: a piece’s moment, a picture file or a video file’s frame
allyhub inspect layout One version’s layout measured now, at its measured moments or at –at / –every; –texts lists every text block with its fonts
allyhub inspect contrast The text against the pixels behind its glyphs now, as WCAG contrast ratios (the check does not measure it)
allyhub dev The project’s items in the browser, each in its editor (docs, sheets, videos, 3D sceneries; websites listed), as their files change; runs until stopped, and run again while it runs, opens its page and ends
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 help docs

Command What it does
allyhub doc cover list AllyHub’s own covers, the editor’s gallery, by name: what each is of
allyhub doc cover set Sets one of AllyHub’s covers on a doc, as the editor’s gallery does: its SVG written beside the doc’s file (cover-<name>.svg) and named in the front matter’s cover; the rest of the file keeps its bytes
allyhub check Problems: objective errors in the project’s items, by rule; exits 1 when one must be fixed
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
allyhub inspect pages A doc’s pages as render prints them, measured from the PDF: the space at each page’s foot, blocks broken over pages with their lines on each, headings near a foot, short last lines, content past the column; and a picture of the pages, each block outlined and labelled by its line in the doc’s file
allyhub dev The project’s items in the browser, each in its editor (docs, sheets, videos, 3D sceneries; websites listed), as their files change; runs until stopped, and run again while it runs, opens its page and ends
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 help sheets

Command What it does
allyhub sheet capabilities What @allyhub/sdk/sheets holds of openpyxl’s (its classes), how it differs and what it adds, and the worksheet functions, as JSON
allyhub sheet import Makes a sheet of an Excel, CSV or TSV file: its sheets, tables, formulas, names and looks as a sheet file and CSV files, listed in allyhub.yaml, said what could not be carried over, each formula computed here and compared with the value the file holds; never over a file that is there
allyhub sheet calc What a sheet computes, without opening anything: a sheet, a range, a table, a name, or every sheet, as an aligned table
allyhub sheet trace What a cell depends on and what depends on it: its formula, where it is written, the places it reads and the cells that read it
allyhub sheet diff Two versions of a workbook compared, by value and by formula: two sheets (each its id or its file), or a sheet and an .xlsx. Cells whose formula changed and value did not are apart from those whose value changed; rows of a table line up by its key, else by their place
allyhub inspect sheet A workbook’s facts, for you to judge, never problems: error values by cell, numbers written into formulas, a cell unlike its neighbours, what nothing reads, exceptions in calculated columns, values under a validation that breaks them, the rounds iterative calculation ran
allyhub sheet Each table of a sheet measured: its columns’ counts, empty, distinct, ranges and frequent values
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
allyhub check Problems: objective errors in the project’s items, by rule; exits 1 when one must be fixed
allyhub dev The project’s items in the browser, each in its editor (docs, sheets, videos, 3D sceneries; websites listed), as their files change; runs until stopped, and run again while it runs, opens its page and ends
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

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

Section titled “Making an image: boards of Photoshop’s layers, a PSD in and out”

allyhub help images

Command What it does
allyhub image import Makes an image of a Photoshop file: a board an artboard (else its canvas), each layer of its kind (pixels, type, shape, adjustment, fill, group) with its blend, opacity, mask and effects, a picture a pixel layer in media/, the words in the script, the file kept in source/; says what it could not carry over as it is; never over a place that is taken
allyhub check Problems: objective errors in the project’s items, by rule; exits 1 when one must be fixed
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
allyhub inspect layout One version’s layout measured now, at its measured moments or at –at / –every; –texts lists every text block with its fonts
allyhub inspect contrast The text against the pixels behind its glyphs now, as WCAG contrast ratios (the check does not measure it)
allyhub dev The project’s items in the browser, each in its editor (docs, sheets, videos, 3D sceneries; websites listed), as their files change; runs until stopped, and run again while it runs, opens its page and ends
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

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

Section titled “Making a website: any web project, with its website JSON listed in allyhub.yaml”

allyhub help websites

Command What it does
allyhub check Problems: objective errors in the project’s items, by rule; exits 1 when one must be fixed
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 frames web A web page’s screenshot with its named elements’ boxes in the image’s pixels, for a screen demo
allyhub frames compare How a candidate picture differs from a reference, as numbers (ΔE, channels, SSIM, levels, grain, edges, regions) with a heatmap and a side-by-side: a piece’s moment, a picture file or a video file’s frame
allyhub site deploy Build a website here and upload it to AllyHub as a new version of its site, sending only the files AllyHub lacks; private until –live
allyhub site status A website’s address and its versions, the live one marked
allyhub site live Make a version of a website what its address serves, an earlier one or one not live yet; nothing is built

Laying a project’s work out on a canvas, with notes and edges

Section titled “Laying a project’s work out on a canvas, with notes and edges”

allyhub help canvases

Command What it does
allyhub inspect canvas A canvas’s nodes and edges as its file has them: each node’s box, colour and what it holds or points at (an item by its kind), what each group holds by place, each edge’s ends, sides and label
allyhub check Problems: objective errors in the project’s items, by rule; exits 1 when one must be fixed
allyhub dev The project’s items in the browser, each in its editor (docs, sheets, videos, 3D sceneries; websites listed), as their files change; runs until stopped, and run again while it runs, opens its page and ends

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

Section titled “Writing for X: a post, a thread, a long post or an article”

allyhub help x

Command What it does
allyhub check Problems: objective errors in the project’s items, by rule; exits 1 when one must be fixed
allyhub inspect The check’s facts, for you to judge, never problems: by kind, part and time
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
allyhub dev The project’s items in the browser, each in its editor (docs, sheets, videos, 3D sceneries; websites listed), as their files change; runs until stopped, and run again while it runs, opens its page and ends
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 help generating

Command What it does
allyhub upload Upload files from this computer for a cloud tool whose input takes a URL (a presenter photo, speech audio, a reference clip), and print a signed URL for each, which works for a few hours
allyhub voice Make the voice files a project’s say(text) parts need, with their cloud voice tool, one per say that has none (assets/media/gen/say/<hash>, its words and its record)

Researching a market online: social, ads, seo, web-search, ecommerce, app-stores

Section titled “Researching a market online: social, ads, seo, web-search, ecommerce, app-stores”

allyhub help researching

Command What it does
allyhub frames web A web page’s screenshot with its named elements’ boxes in the image’s pixels, for a screen demo

Studying reference videos, and a piece against them

Section titled “Studying reference videos, and a piece against them”

allyhub help references

Command What it does
allyhub reference Measure a reference video into .allyhub/work/reference/<id>/: its words, cuts, on-screen text, pace, sound and picture as numbers, contact sheets, and reference.json; your interpretation.json beside it names its sections
allyhub reference compare A piece measured from its code, with no render, against a reference’s sections (your interpretation.json’s, else its neutral segments): per section and overall, the piece’s numbers less the reference’s, and a side-by-side sheet
allyhub reference set A set of references as statistics: every number their reference.json holds, by its path, with its quantiles; each value’s share of their interpretation.json labels; and one folder’s percentile among them
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
allyhub frames compare How a candidate picture differs from a reference, as numbers (ΔE, channels, SSIM, levels, grain, edges, regions) with a heatmap and a side-by-side: a piece’s moment, a picture file or a video file’s frame
allyhub words A recording’s words: heard on this computer when it has none (or –fresh), printed by word index with the sounds between them; a stretch by seconds, heard again with –fresh
allyhub audio How a video sounds: its mix’s loudness, what the master did, silences, onsets against cuts and cues, pace, levels under and between the words, each part’s speech and voice; or a file on its clock, or a file alone
allyhub align The offset between recordings of the same moment, from their sound, with how sharply they match and how it drifts

allyhub help 3d

Command What it does
allyhub add search Finds the starter components, AllyHub’s resources (models, sceneries) and Poly Haven’s CC0 models, HDRIs and textures whose names, tags, categories or descriptions hold every word, each with where its words were found; with no words, lists every one
allyhub add Adds to the project what AllyHub and Poly Haven have, each named <type>/<name>: a starter component, a 3D model, a 3D scenery, a skill or a template from AllyHub’s registry, or a CC0 model, HDRI or texture from Poly Haven; alone it lists everything AllyHub has, by type
allyhub scenery A 3D scenery’s objects with their places, sizes and costs, its lights, cameras, moves and bake
allyhub scenery view Draws a 3D scenery from cameras at moments, each picture captioned with its camera in numbers
allyhub scenery map Draws a 3D scenery from above, the front and the side, orthographic: a grid, each named object’s outline, name and front, the cameras and the moves; and each object’s footprint on the floor
allyhub scenery see What cameras of a 3D scenery see at moments: each named object’s share of the frame, what hides it, what the frame’s edges cut, its distance; the camera’s clearance; the picture’s levels
allyhub scenery measure Measures a 3D scenery’s geometry: surfaces, contacts, gaps and what rests on what; line of sight, clear space and free floor when asked
allyhub scenery motion How one camera of a 3D scenery moves over a stretch, drawing nothing: its channels in its own frame, speed, jerk, smoothness, clearance, and how each named object moves on the frame
allyhub scenery solve Finds the camera that took a picture, from points of a 3D scenery and the pixels they land on
allyhub scenery bake Bakes a 3D scenery’s light into a lightmap once, kept in .allyhub/cache/bake/ and laid on it each time it is built; one baked on a GPU is laid only by that GPU, one baked on the CPU (ALLYHUB_GPU=0) by every renderer
allyhub inspect fidelity A scenery’s screens drawn in the world against their own elements, now; each comparison side by side in .allyhub/work/fidelity/
allyhub dev The project’s items in the browser, each in its editor (docs, sheets, videos, 3D sceneries; websites listed), as their files change; runs until stopped, and run again while it runs, opens its page and ends

Modelling a prop in code, or adding one from a library

Section titled “Modelling a prop in code, or adding one from a library”

allyhub help modeling

Command What it does
allyhub add search Finds the starter components, AllyHub’s resources (models, sceneries) and Poly Haven’s CC0 models, HDRIs and textures whose names, tags, categories or descriptions hold every word, each with where its words were found; with no words, lists every one
allyhub add Adds to the project what AllyHub and Poly Haven have, each named <type>/<name>: a starter component, a 3D model, a 3D scenery, a skill or a template from AllyHub’s registry, or a CC0 model, HDRI or texture from Poly Haven; alone it lists everything AllyHub has, by type
allyhub 3d-model Builds a 3D model’s TypeScript module (defineModel) into a GLB; –inspect measures it without writing one
allyhub 3d-model capabilities What the modelling API supports (the Blender subset, its limits and deliberate differences), as JSON
Section titled “An address of your own: signing up to a site, its codes and links, mail people send you and your answers”

allyhub help mailbox

Command What it does
allyhub mail addresses Your mailbox’s addresses in this organization, which your agents use as their own (made the first time); mail to any of them, with any +tag, comes to the same mailbox
allyhub mail alias Add an address of its own to your mailbox (<name>.<team>@<domain>), for a site that refuses +tags or wants a different address for each account
allyhub mail wait Wait for the next message that matches, received after –since (by default, when the wait starts), and print it whole
allyhub mail search List the mail your mailbox received and sent, newest first; each option narrows it
allyhub mail read Read a message: its text, its links and its attachments’ names; its HTML or the message as it came on ask
allyhub mail send Send a message from your mailbox, to whom your person lets it write (your organization’s people by default); a line under it says an AI agent wrote it
allyhub mail reply Reply to a message, in its thread: to its sender, or with –all to everyone it named; from the address it came to

This computer, the account and AllyHub’s skills

Section titled “This computer, the account and AllyHub’s skills”

allyhub help setup

Command What it does
allyhub skills Lists AllyHub’s work skills, each how to make one kind of work, with what it is for: allyhub skills show <name> prints one, allyhub add skill/<name> puts it in the project
allyhub skills show Prints one of AllyHub’s skills in full, its SKILL.md and the names of its other files, without adding it to the project
allyhub auth login Sign this computer in to AllyHub, for the cloud tools; once per computer, shared with AllyHub Studio
allyhub auth status Whether this computer is signed in to AllyHub, as whom, and the account’s credits; exits 4 when it is not
allyhub orgs list The organizations you are in, with your role; the one this computer acts in and pays from is marked
allyhub orgs use Work in and pay from another of your organizations on this computer: the CLI, Studio and every agent on it
allyhub doctor What this computer has for AllyHub: Node.js, ffmpeg, headless Chrome, yt-dlp, the packages; –install and –remove
allyhub doctor extensions The extensions the project’s dependencies bring: each with its version and folder, and what is wrong with any

These works list AllyHub’s cloud tools, which spend the account’s credits: allyhub help <work> lists a work’s tools, and allyhub <work> <tool> --help says what one takes and how its credits are counted.

Work What its tools do
allyhub ai-media Make images, video, speech and music with AI models, and measure recordings and pictures: words, cut-outs, faces, text.
allyhub social Profiles, posts, videos, comments, followers and trends on social platforms.
allyhub ads Ads and advertisers in Meta’s, Google’s, LinkedIn’s and TikTok’s ad libraries.
allyhub seo Keywords, rankings, AI search visibility, page audits and backlinks.
allyhub web-search Search Google’s web, news, images, videos, scholar and patents.
allyhub ecommerce Products, prices, reviews, sellers and keyword demand on marketplaces and shops.
allyhub app-stores Apps, charts, reviews and keywords on Google Play and the App Store.
Was this page helpful?