Quickstart - ScreenJSON

1. Install the free reference CLI

Download
Docker
Source

Download a platform binary from the releases page:

macOS · Apple Silicon — screenjson-export_Darwin_arm64.tar.gz
macOS · Intel — screenjson-export_Darwin_x86_64.tar.gz
Linux · amd64 — screenjson-export_Linux_x86_64.tar.gz
Linux · arm64 — screenjson-export_Linux_arm64.tar.gz
Windows · amd64 — screenjson-export_Windows_x86_64.zip
Windows · arm64 — screenjson-export_Windows_arm64.zip

tar -xzf screenjson-export_*.tar.gz
sudo mv screenjson-export /usr/local/bin/

docker pull screenjson/export:latest

git clone https://github.com/screenjson/screenjson-export.git
cd screenjson-export
go build -o screenjson-export ./cmd/screenjson-export
sudo mv screenjson-export /usr/local/bin/

2. Convert a file

screenjson-export -i screenplay.fdx -o screenplay.json

Or in Docker:

docker run --rm -v "$PWD:/data" screenjson/export -i /data/screenplay.fdx

Fountain and FadeIn are auto-detected from the file extension:

screenjson-export -i script.fountain -o script.json
screenjson-export -i script.fadein   -o script.json

3. Inspect the output

screenjson-export -i script.fdx | jq '.title.en'
screenjson-export -i script.fdx | jq '.document.scenes | length'
screenjson-export -i script.fdx | jq '.characters[].name'

Next steps

Full CLI

Export to every format, run a REST API, and more.

Try it in the browser

Paste a URL or drop a file — convert without installing anything.

Specification

The shape of a ScreenJSON document.

REST API

Endpoints exposed by screenjson serve.

​1. Install the free reference CLI

​2. Convert a file

​3. Inspect the output

​Next steps