What it does
File every peepshow run as an Outline document under a collection. Title captures the video name and date; body is markdown with a Metadata section plus a numbered Frames list. Optionally publish immediately or leave as a draft.
When to reach for it
- Internal wiki where every processed video gets its own reference page
- Nest under a parent doc via `OUTLINE_PARENT_DOC_ID` to build a hierarchy
- Draft-by-default workflow: reviewers publish once they've checked the content
Install
npm i -g peepshowUse it
OUTLINE_BASE_URL=https://app.getoutline.com \
OUTLINE_API_TOKEN=... \
OUTLINE_COLLECTION_ID=... \
peepshow ./talk.mp4 --sink outlineMake it automatic
Register the sink once — every run fires it afterward. Scope by --when so it only runs for matching videos.
peepshow sinks add outline
peepshow sinks add outline --when extension=mp4,mov
peepshow sinks add outline --when path=/Volumes/Work/Configuration
OUTLINE_BASE_URLOutline instance URL, e.g. `https://app.getoutline.com`. requiredOUTLINE_API_TOKENBearer API token. requiredOUTLINE_COLLECTION_IDCollection to create the doc under. requiredOUTLINE_PARENT_DOC_IDCreate as a child of this doc.OUTLINE_PUBLISH`1` publishes immediately; default leaves as draft.
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 Outline 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 OUTLINE_BASE_URL="..."
export OUTLINE_API_TOKEN="..."
export OUTLINE_COLLECTION_ID="..."2. Register as an auto-sink
peepshow sinks add outline
peepshow sinks add outline --when extension=mp4,mov3. Example LLM session
You → drop a
.movinto Claude Code.Claude → auto-invokes
/peepshow:slides ./clip.mov. peepshow extracts frames + audio, theOutlinesink forwards the run to a new page in your knowledge base. Claude replies with a summary and a link to the created record.
The transcript text is embedded alongside the frame gallery on the created page.
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'.