CLI reference

Every slaide command. Build, render, view, export, shoot, validate, import, compare, and more.


The slaide CLI runs the @aivorynet/core engine. If slaide is not on your PATH, run any command with npx @aivorynet/slaide instead - e.g. npx @aivorynet/slaide new deck.slaide.

Write and preview

slaide new <file.slaide> [--title <t>]    # scaffold a starter deck
slaide validate <deck> [--strict]         # diagnostics. --strict fails on warnings
slaide dev <deck> [--port <n>]            # live preview, re-renders on refresh
slaide view <deck>                        # open the deck in your default browser

Run validate before you render. It reports parse errors and unknown layout, slot, class, and gradient names, with line numbers.

See your deck

slaide shoot <deck> [--out <dir>] [--width <px>] [--scale <n>] [--jpeg]
slaide shoot <deck> --montage <sheet.jpg> [--cols <n>] [--tile <px>]

shoot renders every slide to an image, with builds settled. --montage tiles all slides into one small JPEG. That is the cheap way for an AI to look at its own work and fix problems a render alone cannot show.

Build and render

slaide build <deck> [--out <dir>]         # self-contained <dir>/index.html
slaide render <deck> [--print] [--meta]   # print the HTML to stdout, for the viewer

build inlines local images, video, and audio up to about 6 MB each, and bakes charts to static SVG. The result is one portable HTML file with no engine inside.

Export

slaide export <deck> --pdf <file.pdf>     # one page per slide
slaide export <deck> --pptx [<file>]      # editable PowerPoint. real text, shapes, images
slaide export <deck> --key [<file>]       # Keynote. macOS with Keynote only

Export uses headless Chromium. Run npx playwright install chromium once. In a PDF, all builds are settled and media falls back to its poster frame.

Import and compare

slaide import <file.pptx|.key> [--out <dir>] [--fidelity hybrid|reconstruct|exact-raster] [--slaidec]
slaide compare <orig.pptx|refDir> <deck>  # fidelity vs the original, with SSIM and overlays

See Importing decks for the fidelity modes and how to check a result.

Share and package

Bundle a deck, its master, and every asset into one file. Or unpack one back into a folder.

slaide pack <deck.slaide|folder> [-o <file.slaidec>]
slaide unpack <file.slaidec> [-o <dir>]

A .slaidec is a zip that holds everything a deck needs. The deck, the master, and the assets/. So you can hand off or archive a whole deck as one file. build, render, and view all accept a .slaidec as input. To put a deck on a website, render it to HTML and embed that. The .slaidec is for sharing and archiving, not embedding.

Inspect and automate

slaide slots <deck>                 # list the master's slot, color, gradient, and size names
slaide compile <deck> [--inspect]   # print the compiled IR
slaide themes                       # list bundled themes and their layouts
slaide install                      # install the agent skill and MCP server into your AI CLIs
slaide mcp                          # run the MCP server
slaide --help                       # full usage

Quick reference

Command What it does
new Scaffold a starter deck
validate Validate with diagnostics (--strict)
dev Live preview server
view Open in the default browser
shoot Render slides to images, or one montage sheet
build Self-contained index.html
render Rendered HTML to stdout
export --pdf Export a PDF
export --pptx Export editable PowerPoint
export --key Export Keynote (macOS)
import Convert .pptx or .key to .slaide
compare Measure import fidelity
pack Bundle into one .slaidec
unpack Extract a .slaidec to a folder
slots Print master vocabulary
compile Print the compiled IR
themes List bundled themes
install Install the agent skill and MCP server
mcp Run the MCP server