@wtfb/cli

Validation and export tools for creative projects

Part of the Words To Film By ecosystem.

Installation

npm install -g @wtfb/cli

Usage

# Validate all project files
wtfb validate

# Validate specific types
wtfb validate --fountain    # Fountain files only
wtfb validate --markdown    # Markdown files only
wtfb validate --spelling    # Spell check only

# Export screenplay to PDF
wtfb export-pdf

# Export with specific output path
wtfb export-pdf my-script.fountain -o exports/final.pdf

# Export to Final Draft XML
wtfb export-fdx

# Export to HTML preview
wtfb export-html

# Skip pre-flight validation
wtfb export-pdf --no-validate

# Show CLI info
wtfb info

Commands

wtfb validate

Runs validation across your project files:

| Flag | Description | |------|-------------| | -f, --fountain | Validate Fountain files only | | -m, --markdown | Validate Markdown files only | | -s, --spelling | Run spell check only | | --fix | Auto-fix issues where possible |

wtfb export-pdf [file]

Export Fountain screenplay to industry-standard PDF.

| Option | Description | |--------|-------------| | -o, --output <path> | Custom output path | | --no-validate | Skip pre-flight validation |

wtfb export-fdx [file]

Export Fountain screenplay to Final Draft XML format.

| Option | Description | |--------|-------------| | -o, --output <path> | Custom output path | | --no-validate | Skip pre-flight validation |

wtfb export-html [file]

Export Fountain screenplay to HTML for web preview.

| Option | Description | |--------|-------------| | -o, --output <path> | Custom output path | | --no-validate | Skip pre-flight validation |

Pre-flight Validation

By default, all export commands run validation before generating output. This ensures your screenplay is error-free before export.

To skip validation:

wtfb export-pdf --no-validate

Configuration

The CLI respects project-level configuration files:

| File | Purpose | |------|---------| | cspell.json | Spell check configuration | | .cspell/project-words.txt | Custom dictionary | | .markdownlint-cli2.yaml | Markdown lint rules |

Output Directories

By default, exports are saved to:

exports/
├── pdf/     # PDF files
├── fdx/     # Final Draft XML
└── html/    # HTML previews

Requirements

• Node.js 18+
• For PDF export: afterwriting (installed automatically)

Related

• WTFB Projects Template - Full project template
• Fountain Syntax - Screenplay format reference

License

MIT License - see LICENSE for details.