Back to Help

cli

Terminal Workflows

Practical shell workflows for local automation and CI pipelines.

Audience: developer

Workflow: Render and Wait

slidevids renders create --timeline-id tmpl_xxx

By default, renders create waits until the render reaches a terminal status.

Workflow: Async Render + Poll

slidevids renders create --timeline-id tmpl_xxx --no-wait --json
slidevids renders wait render_xxx --interval 3 --timeout 900 --json
slidevids renders download render_xxx --output ./artifacts/output.mp4

Workflow: JSON for CI

slidevids whoami --json
slidevids timelines list --json
slidevids renders list --json

Workflow: Project Defaults (slidevids.toml)

[defaults]
resolution = "1080p"
codec = "h264"
format = "landscape"

[auth]
base_url = "https://api.slidevids.com"

With defaults, slidevids renders create --timeline-id tmpl_xxx uses project-level output settings automatically.