CLI Reference

Run commands with npx @stdout-design/cli <command> (local install) or studio <command> (global install).

Commands

studio init

Scaffold a new studio project.

studio init [projectDir] [options]

Skips scaffolding if a studio.config.ts already exists. See Getting Started.

studio update

Update an existing studio project to the latest CLI version adds the CLI dependency if missing and merges default config values into studio.config.ts.

studio update [projectDir] [options]

studio render

Render a template single, or batch with --data.

studio render <template> [props...] [options]

<template> is the template ID from studio.config.ts. Props are passed as key=value pairs:

studio render bento-feature title="Hello" stat="10k users"

Examples:

# Single render, all configured presets × locales
studio render stat-card title="50K users"

# Single file, one preset, one locale
studio render stat-card --preset instagram-square --locale en --out-dir out

# Batch from CSV, across two presets and two locales
studio render stat-card --data data/stats.csv --preset instagram-square,x-card --locale en,ar --out-dir out

Output

Each render produces one PNG per (preset × locale × data row), named:

<templateId>.<locale>.<presetId>.<rowKey>.png

For a single render (no --data) the row key is 0, e.g.:

out/stat-card.en.instagram-square.0.png
out/stat-card.en.x-card.0.png
out/stat-card.ar.instagram-square.0.png

A manifest.json is written to the output directory alongside the images, summarizing status, counts, and per-file results (see Batch Rendering).

Exit code is 1 if any render failed. Use --json to get the manifest as machine-readable output.

Flag notes

• --preset and --locale are singular and accept comma-separated values. Omit them to render every configured preset and locale.
• --concurrency is accepted but rendering is currently sequential; it has no effect on output.
• Unknown template IDs trigger a "Did you mean …?" suggestion based on closest match.

studio dev

Start the live preview studio (see Live Studio).

studio dev [rootDir] [options]

--open is accepted but currently a no-op open http://localhost:3030 manually.

studio cache stats

Show cache statistics location, compiled/pixel entry counts, disk usage, and the size limit.

studio cache stats [rootDir] [options]

studio cache clean

Clear the render cache entirely.

studio cache clean [rootDir] [options]

See Caching for how the cache works.

studio lint

Check templates for compatibility. Not implemented yet it always exits with code 1 and a message pointing to a future release.

studio skill install

Install the stdout-design agent skill for AI coding agents.

studio skill install [options]

See AI Agents.

Exit codes

• 0 success (including a cancelled init).
• 1 any error, or any failed render in a batch.