Preview, live, and export

The generated CLI reference exposes a small set of top-level commands. This page shows the ones you will use most often while authoring checked-in samples.

Preview while editing

Preview gives the fastest feedback loop and hot reloads by default:

story preview samples/story/quick-start.story.yaml
story preview samples/story/settle-demo.story.yaml
story preview samples/story/camera-world-demo.story.yaml

If you need to disable file watching:

story preview samples/story/quick-start.story.yaml --no-watch

Run cue-driven presentations live

Use live for fullscreen presentation playback:

story live samples/story/presentation-demo.story.yaml
story live samples/story/svg-demo.story.yaml

These samples include cue: actions. In live mode, cues pause for presenter input. In preview and export, the same cues behave like wait: done, and preview/export can add a hold with --auto-cue.

Export MP4 output

Use export when you want a file instead of a preview window:

story export samples/story/presentation-demo.story.yaml --auto-cue 3
story export samples/story/camera-world-demo.story.yaml -o camera-world-demo.mp4
story export samples/story/video-demo.story.yaml

Add --software if you need the WARP renderer instead of GPU output.

Capture still frames and cue sheets

The CLI also supports deterministic image output:

story frame samples/story/svg-demo.story.yaml --time 2 -o svg-demo.png
story cues samples/story/presentation-demo.story.yaml -o presentation-cues --auto-cue 3

Use frame when you want one known moment. Use cues when you want one image per presentation cue.

TTS-aware preview and export

The TTS sample uses the host default provider unless you override it:

story preview samples/story/tts-demo.story.yaml
story voices --locale en-US
story preview samples/story/tts-demo.story.yaml --tts-provider azure
story export samples/story/tts-demo.story.yaml --tts-provider azure

story voices lists Azure voice short names for a locale. --tts-provider azure switches preview or export to Azure AI Speech when the required environment variables are present.

Where to go next

• Use Story authoring workflow to choose the right sample.
• Use Reference when you need exact option names and arity.
• Use Examples for the visual sample catalog.