Aller au contenu

CLI Reference

Usage

vlatex [OPTIONS] [FILE]

Modes

Mode Commande Description
CLI pur vlatex file.md Convertit et affiche le LaTeX dans stdout
CLI PDF vlatex file.md --pdf Compile en PDF
CLI DOCX vlatex file.md --docx Compile en DOCX
TUI vlatex --tui Interface terminal
GUI vlatex --gui Interface graphique native
GUI vlatex IDem (par défaut)

Options

Option Description
--pdf, -p Compiler en PDF
--docx, -d Compiler en DOCX
--tui, -t Lancer l'interface terminal
--gui, -g Lancer l'interface graphique
--help, -h Afficher l'aide
--version, -v Afficher la version

Exemples

Conversion simple

# Afficher le LaTeX dans le terminal
vlatex document.md

# Sauvegarder en fichier .tex
vlatex document.md > document.tex

Compilation

# PDF
vlatex document.md --pdf
# → output/document.pdf

# DOCX
vlatex document.md --docx
# → output/document.docx

Avec vault personnalisé

# Spécifier le vault root
vlatex Writing/thesis.md --pdf

# Utiliser la config (vault_root défini)
export VAULT_ROOT=/path/to/vault
vlatex thesis.md --pdf

Batch conversion

# Convertir tous les fichiers .md d'un dossier
for f in Writing/*.md; do
  vlatex "$f" --pdf
done

Intégration dans un Makefile

SOURCES = $(wildcard Writing/*.md)
PDFs = $(SOURCES:.md=.pdf)

all: $(PDFs)

%.pdf: %.md
    vlatex $< --pdf

clean:
    rm -rf output/

Sortie

CLI (sans --pdf/--docx)

La sortie est le LaTeX généré, affiché dans stdout. Redirigez vers un fichier :

vlatex document.md > output.tex

CLI --pdf

PDF compiled: output/document.pdf
Output: /path/to/output/document.pdf

CLI --docx

DOCX compiled: output/document.docx
Output: /path/to/output/document.docx

Codes de retour

Code Signification
0 Succès
1 Erreur (fichier non trouvé, erreur de lecture, etc.)

Variables d'environnement

Variable Description Défaut
RUST_LOG Niveau de log info
# Debug
RUST_LOG=debug vlatex document.md

# Warning uniquement
RUST_LOG=warn vlatex document.md --pdf