CLI Reference¶
This page provides a reference for the luci command-line interface.
luci¶
luci [OPTIONS] COMMAND [ARGS]...
Options
- --install-completion¶
Install completion for the current shell.
- --show-completion¶
Show completion for the current shell, to copy it or customize the installation.
archive¶
luci archive [OPTIONS] MAIN
Options
- --output <output>¶
- --validate, --no-validate¶
- Default:
True
- --bbl, --no-bbl¶
- Default:
False
Arguments
- MAIN¶
Required argument
check¶
Check build artifacts for common LaTeX problems with low false positives.
Scans .log files for undefined citations, references, and missing files.
Flags overfull h/v boxes above a configurable threshold (in points).
Exit status is non-zero if any errors are found (or warnings when –strict).
luci check [OPTIONS] [LOGS]...
Options
- --build-dir <build_dir>¶
Directory to search for LaTeX .log files when no files are provided. Defaults to ./build if present, else CWD.
- --overflow-threshold-pt <overflow_threshold_pt>¶
Only flag overfull boxes >= this many points.
- Default:
10.0
- --strict, --no-strict¶
Treat warnings as errors for exit status.
- Default:
False
- --json¶
Output issues as JSON for tooling/CI (suppresses human output).
- Default:
False
Arguments
- LOGS¶
Optional argument(s)
One or more .log files to scan (shell globs supported). If omitted, searches ./build or CWD.
fix-dups¶
Update citations in LaTeX files based on duplicate key mappings from a JSON file.
luci fix-dups [OPTIONS] DUPLICATE_KEYS FILES...
Arguments
- DUPLICATE_KEYS¶
Required argument
- FILES¶
Required argument(s)
merge-acronyms¶
Extract and merge acronyms from multiple LaTeX files into a single file.
luci merge-acronyms [OPTIONS] FILES...
Options
- --output <output>¶
- --command <command>¶
- Default:
'acro'
Arguments
- FILES¶
Required argument(s)
merge-bibs¶
Merge multiple BibTeX files, deduplicate, and write output and removed key map. Earlier files take precedence.
This function takes a list of BibTeX files, merges them into a single file, and then uses bibtex-tidy to deduplicate the entries. The deduplicated BibTeX file is written to the specified output path. A JSON file containing a mapping of the removed duplicate keys to the keys that were kept is also generated.
- Args:
bibfiles: A list of paths to the BibTeX files to merge. output: The path to write the merged and deduplicated BibTeX file to. mapping: The path to write the JSON file with the duplicate key mappings to.
luci merge-bibs [OPTIONS] BIBFILES...
Options
- --output <output>¶
- Default:
PosixPath('merged.bib')
- --mapping <mapping>¶
- Default:
PosixPath('duplicate_keys.json')
Arguments
- BIBFILES¶
Required argument(s)