Options¶
Files and directories¶
Pass one or more files or directories. A directory is searched for .tex
files directly inside it; extensions are matched case-insensitively:
texact .
texact paper.tex chapters/
Use -r or --recursive to also search subdirectories:
texact --recursive .
Directory searches include hidden files and directories, but do not descend into symbolic links to directories. Symbolic links to files are included. Each input is processed independently, so overlapping inputs can be reviewed more than once. A directory with no matching files produces an error.
Inline suppressions¶
To make TeXact ignore certain lines add the following as a LaTeX comment in your source file:
% texact *
To ignore specific rules only on the current line, list their codes using
repeated texact markers:
\begin{figure}[x] % texact FIG001 texact CAS001
The ignore the rest of the file, use:
% texact-file ##
Output verbosity¶
By default, TeXact prints diagnostics without per-file titles or summaries.
If no errors are found across all files, it also prints All passed;
warnings do not prevent this message.
Use --verbose to show per-file titles and reviewer summaries. Use -q
or --quiet to suppress both and the All passed message, while still
showing diagnostics. These options override format.quiet and cannot be
combined. -q cannot be repeated. -v prints the version.
Rule selection¶
Enable disabled rules with --select. Separate multiple rule codes with
commas; repeat the option if needed:
texact --select MAT004,UNS007 paper.tex
Suppress rules with --ignore. Separate multiple rule codes with commas;
repeat the option if needed:
texact --ignore MAT009,CAS001 paper.tex
Command-line selections and ignores are added to those in the configuration. Ignoring a rule takes precedence over selecting it, including when they are specified in different places.
Configuration file¶
TeXact can load optional settings from a TOML file. It searches the current directory in this order and stops at the first TeXact configuration it finds:
.texact.tomltexact.tomlpyproject.tomlunder[tool.texact]
Use --config PATH to select a configuration file explicitly. An explicit
file takes precedence over automatic discovery. Command-line formatting options
take precedence over values loaded from TOML.
The supported structure is:
[lint]
ignore = ["FIG002", "UNS001"]
select = ["MAT004"]
casing = ["LaTeX"]
we_count = 7
[format]
html-style = true
vscode-style = true
quiet = 2
[tools]
chktex_path = "/usr/bin"
lint.ignore accepts rule codes to suppress. lint.casing adds
spellings to the built-in casing list. lint.select enables rules that are
disabled by default. lint.we_count changes the maximum allowed number of
we occurrences. format.html-style enables HTML
output by default. format.quiet selects one of three output levels:
0 is verbose, with titles and summaries; 1 (the default) is normal,
with no titles or summaries and an All passed message if there are no
errors; and 2 is quiet, showing diagnostics only. format.vscode-style
enables VS Code-compatible diagnostic output. tools.chktex_path points to a
ChkTeX executable or directory.
When no configuration file exists, TeXact uses its normal built-in defaults.