Home

stencila demo

Run a terminal demonstration from a document

Usage

stencila demo [OPTIONS] <INPUT> [OUTPUT] [-- <AGG_ARGS>...]

Examples

# Demo a document in the terminal (uses natural preset by default)
stencila demo document.md

# Record a demo to an animated GIF
stencila demo document.md demo.gif

# Use fast preset for quick, smooth typing
stencila demo document.md --preset fast

# Use fast preset but add some typing variance
stencila demo document.md --preset fast --speed-variance 0.2

# Use fast preset but extend the maximum duration of running times
stencila demo document.md --preset fast --min-running 2000 --max-running 4000

# Use instant preset for immediate results
stencila demo document.md --preset instant

# Disable syntax highlighting for code blocks
stencila demo document.md --no-highlighting

# Demo only specific slides (slides are delimited by ***)
stencila demo document.md --slides 2-4

# Demo multiple slide ranges
stencila demo document.md --slides "1,3-5,7-"

Arguments

NameDescription
<INPUT>The path of the document to demo.
[OUTPUT]The path of the recording to generate.
[AGG_ARGS]Arguments to pass through to agg when recoding to GIF.

Options

NameDescription
--presetPreset for demo style. Default value: natural.
--speedTyping speed in words per minute. Default value: 100.
--speed-varianceVariance in typing speed (0.0 to 1.0). Default value: 0.3.
--punctuation-pauseHow long to pause after punctuation (milliseconds). Default value: 200.
--typo-rateProbability of making a typo (0.0 to 1.0). Default value: 0.
--typo-pauseHow long to pause after typos before correcting (milliseconds). Default value: 500.
--hesitation-rateProbability of brief hesitation (0.0 to 1.0). Default value: 0.
--hesitation-durationHesitation duration in milliseconds. Default value: 100.
--no-highlightingDo not apply syntax highlighting to code. Possible values: true, false.
--min-runningMinimum duration for running spinner in milliseconds. Default value: 500.
--max-runningMaximum duration for running spinner in milliseconds. Default value: 5000.
--slidesSpecify which slides to demo.
--no-executeDo not execute the document before running the demo. Possible values: true, false.
--cacheCache the document after executing it. Possible values: true, false.
--ignore-errorsIgnore any errors while executing document. Possible values: true, false.
--force-allRe-execute all node types regardless of current state. Possible values: true, false.
--skip-codeSkip executing code. Possible values: true, false.
--skip-instructionsSkip executing instructions. Possible values: true, false.
--retain-suggestionsRetain existing suggestions for instructions. Possible values: true, false.
--force-unreviewedRe-execute instructions with suggestions that have not yet been reviewed. Possible values: true, false.
--force-acceptedRe-execute instructions with suggestions that have been accepted. Possible values: true, false.
--skip-rejectedSkip re-executing instructions with suggestions that have been rejected. Possible values: true, false.
--dry-runPrepare, but do not actually perform, execution tasks. Possible values: true, false.

Possible values of --preset

ValueDescription
slowSlower typing with some typos and hesitation
naturalAverage WPM, typo and hesitation rate
fast200 WPM, no hesitation, no typos, consistent code running time
instantVery high WPM and zero code running times
© 2026 Stencila