CLI Reference¶
This page provides a reference for the luci command-line interface.
luci¶
Utilities for LaTeX projects: check logs, merge bibs, archive sources, and consolidate acronyms.
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¶
Create a zip archive of a LaTeX project by flattening inputs.
Flattens includes and strips paths from common commands to collect local dependencies next to the main file, then zips them. With –validate, runs tectonic on the archive to ensure it compiles; with –bbl, includes generated .bbl files after a build.
luci archive [OPTIONS] MAIN
Options
- --output <output>¶
- --validate, --no-validate¶
- Default:
True
- --bbl, --no-bbl¶
- Default:
False
- --bibstyle <bibstyle>¶
- Default:
<BibStyle.bibtex: 'bibtex'>- Options:
biblatex | bibtex
Arguments
- MAIN¶
Required argument
check¶
Check LaTeX .log files for common issues.
Exits with non-zero on errors (or warnings with –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 LaTeX citation keys using a JSON mapping.
Use the mapping produced by merge-bibs (old→new keys) to rewrite citation commands (e.g. cite, citet) across one or more files.
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 and deduplicate using bibtex-tidy.
Writes the deduplicated BibTeX to –output and a JSON map of removed duplicate keys to kept keys to –mapping. Earlier files take precedence. Requires bibtex-tidy to be installed and on PATH.
luci merge-bibs [OPTIONS] BIBFILES...
Options
- --output <output>¶
- Default:
PosixPath('merged.bib')
- --mapping <mapping>¶
- Default:
PosixPath('duplicate_keys.json')
Arguments
- BIBFILES¶
Required argument(s)