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 is an open schema for screenplay data and a set of tools that produce, consume, render, and manage it. These docs are reference, grounded in what each tool actually does. Every flag, environment variable, task, and endpoint below matches the released source. For narrative articles, audience guides, and how-tos, see screenjson.com.

Tools

screenjson-export

Free, open-source CLI. FDX / Fountain / FadeIn → ScreenJSON. MIT-licensed.

screenjson-cli

The full CLI. All formats in and out, validation, encryption, REST API.

screenjson-ui

Embeddable JavaScript viewer. CDN or npm, plain HTML, React, Svelte.

Greenlight

Batch microservice. Job queue, S3 ingestion, pipeline tasks, webhooks.

API Reference

screenjson-cli server

REST endpoints exposed by screenjson serve.

Greenlight service

Job submission, results, workers, storage, tasks.

Specification

ScreenJSON schema

The authoritative reference for the document model, shared types, element types, layout, and analysis.