What it does
Upload each frame to a Miro board using the file-from-device image endpoint. Tiles lay out on a grid (configurable columns, gap, origin) so a run reads left-to-right, top-to-bottom like a comic strip — great for storyboarding, retro boards, or visual QA.
When to reach for it
- Storyboard a video on a Miro board automatically
- Retro board: drop incident-recording frames for team review
- Design critique: video references land next to UI mocks without file juggling
Install
npm i -g peepshowUse it
MIRO_TOKEN=... \
MIRO_BOARD_ID=uXjVO... \
peepshow ./storyboard.mp4 --sink miroMake it automatic
Register the sink once — every run fires it afterward. Scope by --when so it only runs for matching videos.
peepshow sinks add miro
peepshow sinks add miro --when extension=mp4,mov
peepshow sinks add miro --when path=/Volumes/Work/Configuration
MIRO_TOKENOAuth access token (sent as Bearer). requiredMIRO_BOARD_IDTarget board id (URL-safe, includes the `uX…` prefix). requiredMIRO_TILE_WIDTHPer-tile width in px. Default `320`.MIRO_TILES_PER_ROWGrid columns. Default `6`.MIRO_GAPGap between tiles in px. Default `40`.MIRO_ORIGIN_XGrid origin x. Default `0`.MIRO_ORIGIN_YGrid origin y. Default `0`.MIRO_API_URLOverride for self-hosted / staging gateways.
Use with an LLM agent
Every peepshow sink reads its config from env vars and receives a single JSON payload on stdin. An LLM agent (Claude Code, Cursor, Windsurf, Gemini, Codex) can drive the Miro sink automatically when three things are true:
- the env vars below are exported in the agent's shell (or a project
.envit can load), - the
peepshowCLI is onPATH— install withnpm i -g peepshow, - a peepshow auto-sink is registered for the run (optional but recommended — makes invocation zero-argument).
1. Set the environment
# Add to ~/.zshrc, ~/.bashrc, or a project .env the agent can load
export MIRO_TOKEN="..."
export MIRO_BOARD_ID="..."2. Register as an auto-sink
peepshow sinks add miro
peepshow sinks add miro --when extension=mp4,mov3. Example LLM session
You → drop a
.movinto Claude Code.Claude → auto-invokes
/peepshow:slides ./clip.mov. peepshow extracts frames + audio, theMirosink forwards the run to the configured board. Claude replies with a summary and a link to the created record.
The transcript rides along in the payload whenever the audio pass transcribes successfully.
Write your own
A sink is any executable that reads the --emit json payload on stdin. Shell, Node, Python, Go — the spec's in docs/PLUGINS.md. Register persistent ones with peepshow sinks add-cmd 'your-command'.