GRAMMALECTE(1)

✨ NAME ✨

ok so this is grammalecte-cli — the command-line interface for grammalecte 💅 she's the terminal version of the whole thing, no GUI, just vibes and flags.

🎀 SYNOPSIS 🎀

grammalecte-cli [OPTION]...

🦋 DESCRIPTION 🦋

Grammalecte is a French language spellchecker, grammar checker and hyphenator. no cap, all three. bestie speaks French AND corrects your French. iconic behavior honestly 🌸

💖 OPTIONS 💖 (the whole menu, we're not skipping a single one)

• -h, -?, --help — shows a help message and dips. that's it, that's the flag 🫶
• -f, --file FILE — parse FILE (UTF-8 required! like, required required). heads up tho: on Windows, -f acts similar to -ff 👀
• -ff, --file_to_file FILE — parse FILE (UTF-8 required!) and create a result file (*.res.txt)
• -fff, --interactive_file_to_file FILE — parse FILE (UTF-8 required!) and create a result file (*.res.txt)
• -owe, --only_when_errors — only shows results when there are errors. if everything's clean she just doesn't speak. silent queen 💀
• -j, --json — generates a list of errors in JSON (only with option --file or --file_to_file)
• -cl, --concat_lines — concatenates lines that aren't separated by an empty paragraph (only with option --file or --file_to_file)
• -tf, --textformatter — auto-formats text according to typographical rules (not with option --concat_lines)
• -tfo, --textformatteronly — auto-formats text and disables grammar checking entirely (only with option --file or --file_to_file)
• -ctx, --context — returns errors with context (only with option --json)
• -wss, --with_spell_sugg — adds suggestions for spelling errors (only with option --file or --file_to_file)
• -pdi, --personal_dict FILE — loads a personal dictionary (a JSON file)
• -w, --width WIDTH — width in characters (40 < WIDTH < 200; default: 100)

supported values for WIDTH: 40, 50, 60, 70, 80, 90, 100, 110, 120, 130, 140, 150, 160, 170, 180, 190, 200

• -lo, --list_options — lists options
• -lr, --list_rules [RULE]... — lists rules, and you can pass a [regex pattern as filter] if you want
• -sug, --suggest WORD — gets the suggestions list for a given WORD
• -on, --opt-on [OPT]... — activates options
• -off, --opt-off [OPT]... — deactivates options
• -roff, --rule_off [RULE]... — deactivates rules
• -d, --debug — debugging mode (only in interactive mode)

ngl the flags pile up in here like it's a group chat, so read the "only with" notes twice before you come for me. and seriously: UTF-8 required on those file flags. don't test her. 😭

💅 REPORTING BUGS 💅

found a bug? report it, bestie, she wants to know fr fr:

<http://code.grammalecte.net:8080/rptview?rn=1>

that's the whole page, babes 🫶 this was grammalecte-cli, the User Commands edition, dating all the way back to April 2021 ✨ go forth and let her check your French, periodt 👑