Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.screenjson.com/llms.txt

Use this file to discover all available pages before exploring further.

screenjson export -i <input.json> -f <format> [-o <output-file>] [options]
Exports a ScreenJSON document to FDX, FadeIn, Fountain, PDF, JSON, or YAML.

​
Flags

​
Core

FlagDefaultDescription
-i · --input <path>—ScreenJSON input file. Required.
-o · --output <path>stdoutOutput file (or stdout if omitted / -).
-f · --format <name>—Required. Output format: fdx · fadein · fountain · pdf · json · yaml.
--decrypt <key>—Decrypt encrypted content runs before exporting.
--lang <tag>enPrimary language to pick from each text map.
-q · --quietfalseSuppress non-error output.
--verbosefalseVerbose logging to stderr.

​
PDF export

FlagDefaultDescription
--pdf-paper <size>letterPaper size: letter · a4.
--pdf-font <font>courierFont: courier · courier-prime.
--gotenberg <url>—Gotenberg URL for HTML→PDF rendering. Optional; falls back to the native PDF encoder.

​
Examples

# FDX export
screenjson export -i script.json -f fdx -o script.fdx

# Fountain
screenjson export -i script.json -f fountain -o script.fountain

# PDF with A4 paper
screenjson export -i script.json -f pdf --pdf-paper a4 -o script.pdf

# Decrypt and export
screenjson export -i cipher.json -f fdx --decrypt "SharedSecret123" -o script.fdx

# Pick French as the primary language
screenjson export -i multilang.json -f fdx --lang fr -o script-fr.fdx

# External Gotenberg renderer
screenjson export -i script.json -f pdf --gotenberg http://gotenberg:3000 -o script.pdf

​
Behaviour

  • Output is written to stdout if -o is omitted or set to -.
  • The binary accepts ScreenJSON in either JSON or YAML; it detects by attempting JSON parse first.
  • --lang controls which key is pulled from each text map at export time. Missing keys fall through to the document’s root lang.