Skip to content

Command Line Interface

Jump to bottom
lrg4you edited this page Aug 7, 2026 · 1 revision

Command-Line Interface

LRGEX Compress has a simple CLI for scripting, automation, or users who prefer the terminal. The GUI progress window always appears (the tool is a GUI app), but all control is via arguments.

Commands

Compress

lrgex-compress <folder-or-file>

Compresses a file or folder into a .zgx archive next to it.

  • Input: C:\Backups\MyFolder
  • Output: C:\Backups\MyFolder.zgx

The archive is named after the input (folder name with no extension, or the file name with .zgx replacing the original extension).

Example:

lrgex-compress "C:\Users\me\Desktop\Project"

Creates C:\Users\me\Desktop\Project.zgx.

Extract (to subfolder)

lrgex-compress -x <archive>

Extracts an archive into a new subfolder named after the archive.

  • Input: C:\Backups\Project.zgx
  • Output: C:\Backups\Project\ (new folder containing extracted files)

Example:

lrgex-compress -x "C:\Users\me\Desktop\Backup.zgx"

Creates C:\Users\me\Desktop\Backup\.

Extract Here (into current folder)

lrgex-compress -x -h <archive>

Extracts the archive's contents directly into the archive's parent folder — no subfolder created.

  • Input: C:\Backups\Project.zgx
  • Output: files appear directly in C:\Backups\

Example:

lrgex-compress -x -h "C:\Users\me\Desktop\Backup.zgx"

Help

lrgex-compress --help

Shows usage information.

Supported archive formats for extraction

Format Extract?
.zgx (tar.zst) ✅
.zip ✅
.rar ✅

Format is detected automatically — you don't specify it. You can extract any of these with the same -x command.

Exit codes

Code Meaning
0 Success
Non-zero Failure (the progress window shows the error)

Notes

  • The progress window always appears — LRGEX is a GUI app, not a console tool. This is by design: you always see live speed and ETA, even when scripting.
  • No compression level flag. There are no settings to pass. LRGEX always uses optimized defaults (zstd level 1, all CPU cores).
  • No output path flag. Archives are always created next to the source; extraction always goes next to the archive. If you need files somewhere specific, compress/extract in place and then move them.
  • No quiet/silent mode. If you need fully headless compression for a server pipeline, use the standard zstd CLI tool instead — LRGEX is a desktop tool with a GUI.

Clone this wiki locally