Command-line interface

The one-stop-shop for LaTeX checking.

usage: latexbuddy [-h] [--version | --wl_add_keys KEY [KEY ...] |
                  --wl_from_wordlist WORD_LIST LANGUAGE | --flask]
                  [--config CONFIG] [--verbose] [--language LANGUAGE]
                  [--whitelist WHITELIST] [--output OUTPUT]
                  [--format {HTML,html,JSON,json,HTML_FLASK,html_flask}]
                  [--enable-modules ENABLE_MODULES | --disable-modules DISABLE_MODULES]
                  file [file ...]

Named Arguments

--version, -V

show program’s version number and exit

--wl_add_keys, -ak

Arguments are valid keys that should be added to whitelist. Ideally the keys are copied from LaTeXBuddy HTML Output

--wl_from_wordlist, -awl

First argument is a file containing a single word per line, second argument is the language of the words. The words get parsed to keys and the keys get added to the whitelist as spelling errors that will be ignored by LaTeXBuddy

--flask

This option starts a local webserver to check your documents with a GUI.

Default: False