CLI Reference¶

jettex provides a beautiful command-line interface with Rich formatting for progress bars, tables, and styled output.

Installation¶

The CLI is installed automatically with the package:

pip install jettex

Global Options¶

These options can be used with any command:

Option	Description
`-v, --verbose`	Enable verbose output with debug information and timestamps
`-q, --quiet`	Suppress all output except errors
`--log-file FILE`	Write debug logs to a file
`-h, --help`	Show help message

Verbosity Levels¶

Normal (default)Verbose (-v)Quiet (-q)

jettex list

Shows formatted output with Rich tables and panels.

jettex -v compile document.tex

Includes debug information with timestamps, useful for troubleshooting.

jettex -q install

Only shows errors. Perfect for scripts and CI/CD pipelines.

Logging to File¶

Write detailed debug logs to a file while keeping normal console output:

jettex --log-file debug.log compile document.tex

The log file contains full debug information regardless of verbosity level.

Commands¶

jettex install¶

Install TinyTeX with a beautiful progress bar:

# Install default version (~100 MB, ~90 packages)
jettex install

# Install specific version
jettex install --version 0  # Minimal (~1 MB, no packages)
jettex install --version 1  # Default (~100 MB)
jettex install --version 2  # Extended (~200+ MB)

# Install to custom directory
jettex install --dir /opt/tinytex

# Force reinstall
jettex install --force

Example output:

⠋ Downloading TinyTeX ━━━━━━━━━━━━━━━━━━━━ 45.2/89.1 MB 12.5 MB/s 0:00:04
╭──────────────────── TinyTeX Installed ────────────────────╮
│ Installed to: /Users/user/Library/TinyTeX                 │
╰───────────────────────────────────────────────────────────╯

jettex uninstall¶

Remove TinyTeX:

jettex uninstall

jettex compile¶

Compile a LaTeX document with a spinner and styled result:

# Basic compilation (with auto-install)
jettex compile document.tex

# Specify engine
jettex compile document.tex --engine pdflatex
jettex compile document.tex --engine xelatex
jettex compile document.tex --engine lualatex
jettex compile document.tex --engine latexmk

# Specify output directory
jettex compile document.tex --output-dir ./build

# Disable automatic package installation
jettex compile document.tex --no-auto-install

Example output (success):

╭─────────────────── Compilation Successful ────────────────────╮
│ Output: /Users/user/documents/thesis.pdf                      │
╰───────────────────────────────────────────────────────────────╯

Example output (failure):

╭──────────────────────── Compilation Failed ───────────────────╮
│ Compilation failed.                                           │
│                                                               │
│ ! LaTeX Error: File `missing.sty' not found.                 │
╰───────────────────────────────────────────────────────────────╯

jettex install-pkg¶

Install LaTeX packages:

# Install one package
jettex install-pkg geometry

# Install multiple packages
jettex install-pkg geometry amsmath hyperref tikz

Example output:

╭─────────────────── Packages Installed ────────────────────╮
│ Installed: geometry, amsmath, hyperref, tikz              │
╰───────────────────────────────────────────────────────────╯

jettex remove-pkg¶

Remove LaTeX packages:

jettex remove-pkg package-name
jettex remove-pkg pkg1 pkg2 pkg3

jettex search¶

Search for packages:

# Search by package name
jettex search tikz

# Search by file name
jettex search --file geometry.sty

Example output:

         Search Results
┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓
┃ Package       ┃ File          ┃
┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩
│ tikz          │               │
│ tikz-cd       │               │
│ tikz-3dplot   │               │
└───────────────┴───────────────┘

jettex update¶

Update packages:

# Update all packages
jettex update --all

# Update tlmgr itself
jettex update --self

# Update both
jettex update --all --self

jettex list¶

List installed packages in a formatted table:

jettex list

Example output:

         Installed Packages
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Package                           ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ amsmath                           │
│ babel                             │
│ geometry                          │
│ hyperref                          │
│ tikz                              │
└───────────────────────────────────┘
92 packages total.

jettex info¶

Show information in formatted panels:

# Show TinyTeX info
jettex info

# Show package info
jettex info geometry

Example output (TinyTeX info):

╭──────────────────── TinyTeX Information ─────────────────────╮
│  TinyTeX Root   /Users/user/Library/TinyTeX                  │
│  Version        TeX Live 2025                                │
╰──────────────────────────────────────────────────────────────╯

Example output (package info):

╭─────────────────────────── geometry ─────────────────────────╮
│  Name        geometry                                        │
│  Category    Package                                         │
│  Revision    12345                                           │
│  Installed   Yes                                             │
╰──────────────────────────────────────────────────────────────╯

jettex version¶

Show jettex version:

jettex version

Exit Codes¶

Code	Meaning
0	Success
1	Error (check output for details)
130	Interrupted (Ctrl+C)

Examples¶

Full Workflow¶

# Install TinyTeX
jettex install

# Check installation
jettex info

# Compile a document
jettex compile thesis.tex --engine xelatex

# Install additional packages if needed
jettex install-pkg tikz pgfplots

# Compile again
jettex compile thesis.tex --engine xelatex

Batch Processing¶

# Compile multiple documents quietly
for f in *.tex; do
    jettex -q compile "$f"
done

CI/CD Usage¶

# Install TinyTeX in CI (quiet mode)
jettex -q install --version 1

# Install required packages
jettex -q install-pkg geometry hyperref booktabs

# Compile document with logging
jettex --log-file build.log compile report.tex --no-auto-install

# Exit code indicates success/failure

Debugging Compilation Issues¶

# Use verbose mode to see what's happening
jettex -v compile problematic.tex

# Or save debug logs to a file
jettex --log-file debug.log compile problematic.tex

Environment Variables¶

Variable	Description
`TINYTEX_HOME`	Custom TinyTeX installation directory

Help¶

Get help for any command:

jettex --help
jettex install --help
jettex compile --help