WholeClear CLI 11.0

Convert and migrate email from the command line.

Use a guided interactive menu or type advanced commands to move mail between PST, OST, EML, MSG, MBOX, Thunderbird, TGZ, contacts, IMAP, Microsoft 365, and more—reports land under WholeClear-Reports on every run.

What it does

WholeClear CLI is a Windows command-line product that:

  • Converts mailboxes and message stores (PST, OST, EML, MSG, MBOX, Thunderbird, TGZ, and related formats).
  • Extracts attachments, calendars, contacts, and structured exports when you choose extract-oriented targets.
  • Downloads or uploads via IMAP and Microsoft 365 (Graph) when configured.
  • Writes IT-friendly HTML, CSV, and JSON reports under <output>\WholeClear-Reports\latest-report.html (and companion files).
Launch tip: Open the Start Menu or Desktop shortcut (black console window). Do not double-click wholeclear.exe alone—the window closes immediately without the shortcut wrapper.

Two usage modes

Beginners and power users share the same conversion engine; only the entry path differs.

ModeWhoHow you work
BeginnerFirst-time or non-technical usersOpen the interactive numbered menu: pick options, paste paths, confirm. No flags to memorize.
AdvancedIT, scripts, automationType direct commands (convert, batch, migrate, …) in Command Prompt, PowerShell, or CI.

See Interactive Menu for the beginner flow and Convert / Batch & Jobs for advanced commands.

Two Windows editions (Demo + Full)

EditionTypical Setup EXELimitsActivation
Evaluation (Demo)wholeclear.exe25 items per jobNo product key (activation disabled)
Full (Licensed)WholeClear-CLI-Setup-11.0.0.exeUnlimited after unlockInstaller may ask a setup password; first run asks for a product activation key

Details: Install & Setup and License & Demo.

Command tree

At a glance, how the CLI is organized when you run advanced commands or follow what the menu builds for you.

wholeclear ← interactive menu (Beginner) when a terminal is attached wholeclear menu ← same menu ├── version ├── system info ├── formats / list ├── license status | activate ├── assess / validate ├── convert / batch ├── jobs list | status | resume | cancel └── migrate --config … --target …

Quick start

Beginner

1

Install

Run Demo or Full setup, then open WholeClear CLI or WholeClear CLI Demo from the shortcut.

2

Open the menu

Type:

wholeclear
3

Pick a task

Choose 1 Convert (or 5 for IMAP interactive), follow prompts, and confirm.

4

Open the report

Reports: <output>\WholeClear-Reports\latest-report.html

Advanced

wholeclear version wholeclear license status -o text wholeclear convert -s "C:\Data files\eml" -t "%USERPROFILE%\Desktop\Out" --from eml --to pst wholeclear list --from eml

Default result format is text (human tables). Use -o json for scripts and automation.

Documentation map

Recommended reading order on this site (PHP guides mirror the shipped cli/info markdown).

#TopicPage
1Terms, beginner vs advanced, first commandsGetting Started
2Demo/Full installers, PATH, verifyInstall & Setup
3Beginner interactive menuInteractive Menu
4Advanced: convertConvert
5Batch and jobsBatch & Jobs
6IMAP / M365 / migration JSONMigrate & Cloud, Migration JSON, Office 365 OAuth
7License, options, samples, scripting, command bibleLicense & Demo, Options Reference, Samples, Scripting & Automation, Command Reference
8Formats list + interactive helpersFormats & Routes, Format Command Helper, Conversion Steps
9Assess / validate, troubleshoot, error catalogAssess & Validate, Troubleshooting, Errors & Exit Codes
Interactive tools & samples: Use Format Command Helper or Conversion Steps for route-specific commands. Download ready JSON / scripts from Samples. Search every symptom in Errors & Exit Codes.

Build scripts (developers)

If you build from source, typical scripts produce publish folders and signed Setup EXEs:

  • apps\cli\scripts\Publish-Cli.ps1 -Rid win-x64 -Edition demo|full
  • apps\cli\scripts\Build-CliDemoInstaller.ps1
  • apps\cli\scripts\Build-CliFullInstaller.ps1

Ship signed Setup EXEs for distribution (Authenticode). See apps\cli\docs\PACKAGING.md in the repo.

Support checklist

  • Open via the shortcut, not a bare double-click on wholeclear.exe.
  • wholeclear version runs successfully.
  • Demo: expect the 25-item cap; Full: activate the key before heavy conversion.
  • PDF output: installer must include pdf\wkhtmltopdf.exe.
  • NSF / Notes: use the win-x86 package plus HCL Notes.
  • Cloud Graph: supply JSON and tokens per Office 365 OAuth; single IMAP download can use menu 5 (interactive).