Skip to content

CLI References

escapist

Usage: escapist [OPTIONS] COMMAND [ARGS]...

  Jinja2 template rendering CLI.

  Render templates with JSON data and custom settings.

Options:
  --version      Show the version and exit.
  -v, --verbose  Enable verbose output for debugging
  --help         Show this message and exit.

Commands:
  batch   Render multiple templates in batch.
  render  Render a Jinja2 template.

escapist batch

Usage: escapist batch [OPTIONS] TEMPLATE_DIR

  Render multiple templates in batch.

  TEMPLATE_DIR is the path to the folder containing templates.

Options:
  -p, --pattern TEXT          File pattern to match (e.g., '*.html', '*.xml')
  -d, --data FILE             Path to JSON data file
  -s, --settings FILE         Path to JSON settings file
  -o, --output-dir PATH       Output directory  [required]
  -e, --output-file-ext TEXT  Output file extension (e.g., 'html')
  -f, --force                 Overwrite output files if they exist
  --help                      Show this message and exit.

escapist render

Usage: escapist render [OPTIONS] TEMPLATE

  Render a Jinja2 template.

  TEMPLATE is the path to the template file to be processed.

Options:
  -d, --data FILE      Path to JSON data file.
  -s, --settings FILE  Path to JSON settings file.
  -o, --output PATH    Output file path (prints to stdout if not specified).
  -f, --force          Overwrite output file if it exists.
  --help               Show this message and exit.