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.

​
Pull

docker pull screenjson/cli:latest
The image ships Poppler’s pdftohtml for PDF import; no extra setup required.

​
CLI mode

Mount the current directory and run any subcommand: 
# Help
docker run --rm screenjson/cli help

# Convert a local file
docker run --rm -v "$PWD:/data" screenjson/cli \
  convert -i /data/screenplay.fdx -o /data/screenplay.json

# Validate
docker run --rm -v "$PWD:/data" screenjson/cli \
  validate -i /data/screenplay.json --strict

# Export to PDF (A4)
docker run --rm -v "$PWD:/data" screenjson/cli \
  export -i /data/screenplay.json -f pdf --pdf-paper a4 -o /data/screenplay.pdf

​
Server mode

docker run --rm -p 8080:8080 \
  -e SCREENJSON_GOTENBERG_URL=http://gotenberg:3000 \
  screenjson/cli serve --port 8080

​
docker-compose

services:
  screenjson:
    image: screenjson/cli:latest
    ports: ["8080:8080"]
    environment:
      - SCREENJSON_GOTENBERG_URL=http://gotenberg:3000
      - SCREENJSON_TIKA_URL=http://tika:9998
    command: ["serve", "--port", "8080"]

  gotenberg:
    image: gotenberg/gotenberg:8
    ports: ["3000:3000"]

  tika:
    image: apache/tika:latest
    ports: ["9998:9998"]

​
Kubernetes

The same image runs as a Deployment in server mode. See Greenlight deploy for an opinionated, queue-backed production configuration on top of this image.