WholeClear CLI

Email conversion and migration for IT—scriptable, batchable, resumable.

Move mailboxes and archives from the Windows command line when volume, repeatability, or unattended runs matter more than clicking through a wizard. Windows-only—not Linux or macOS. Demo (25 items) or Full with CLI Automation.

Windows 10 / 11 x64 (same build can run on Server hosts) · Demo capped at 25 items · Scripting guide

Built for operators who live in the terminal

The desktop GUI still fits one-off jobs. Use the CLI when you need volume, a Windows Server host, Task Scheduler, or the same run tomorrow morning.

IT & sysadmins

Hundreds of PST files, cutover weekends, and scripts that must behave the same on every host.

MSPs & migration vendors

Repeatable playbooks across clients—change the config, keep the command.

eDiscovery & legal IT

Controlled exports, naming rules, HTML/JSON reports, and a clear audit trail of what ran.

DevOps & automation

CI jobs, Task Scheduler, RMM hooks, PowerShell pipelines, exit codes you can branch on.

Power users

Same conversion engine as the GUI—without click fatigue on long runs.

Beginners (menu mode)

Prefer numbers over flags? Open the interactive menu and walk through convert, batch, or IMAP download.

Why teams pick the command line

Built for unattended batch runs on Windows—low babysitting, clear exit codes, same engine as the desktop tools.

01

Schedule it and leave

Point Task Scheduler or an RMM script at convert, batch, or migrate. No interactive desktop session required for headless runs.

02

Resume failed work

Batch jobs keep checkpoints. Interrupt a cutover, then continue without starting from zero.

03

Mailbox and cloud routes

IMAP downloads, IMAP-to-IMAP, and Microsoft 365 via user Graph/IMAP credentials—next to classic file conversions. Not domain-admin impersonation or native Exchange.

04

Menu or full CLI

Start with the numbered menu on an RDP/console session, then move the same job into a script. Both paths hit the same engine.

05

Fits your toolchain

Call wholeclear from PowerShell, Python, CMD, or a scheduler. Parse -o json and exit codes—no separate SDK.

06

Licensed as CLI Automation

Full CLI unlocks with the CLI Automation edition ($1,499)—includes Enterprise desktop rights. May share licW.db with the GUI on the same PC.

What you can drive from the prompt

Common mailbox and archive formats, plus the operations admins actually schedule.

Sources & destinations

  • PST
  • OST
  • EML
  • MSG
  • MBOX
  • Thunderbird
  • TGZ
  • PDF / HTML
  • VCF
  • IMAP
  • Microsoft 365
  • NSF*

*NSF / Notes routes need the 32-bit (x86) build and a working HCL/IBM Notes environment on Windows—not on Mac/Linux. No OLM, Office-doc, or image destinations.

Operations

  • convert
  • batch
  • migrate
  • jobs
  • assess
  • validate
  • license
  • formats

Flag lists and samples live in the CLI documentation. This page covers platform fit, licensing, and how jobs behave in production.

PowerShell — folder of PSTs

Same binary as CMD. Loop files, or call batch once over a folder with --resume.

Get-ChildItem "D:\PSTs\*.pst" | ForEach-Object { wholeclear convert -s $_.FullName -t "E:\EML\$($_.BaseName)" --from pst --to eml if ($LASTEXITCODE -ne 0) { Write-Error "Failed: $($_.Name) ($LASTEXITCODE)" } }

How a first job usually goes

Three steps from installer to report—menu for learning, scripts for production.

Install

Run the Windows Setup on a workstation or Server host, open the Start Menu shortcut, and confirm wholeclear version.

Run

Type wholeclear for the guided menu, or call convert / batch / migrate from PowerShell, CMD, or Task Scheduler.

Deliver

Collect output under your target folder and open WholeClear-Reports\latest-report.html for a readable summary.

Migration JSON should reference environment variables for passwords and tokens (for example $env:WC_IMAP_PASSWORD / WC_GRAPH_TOKEN) so credentials are not stored as plain text in the config file. See Migration JSON and Samples.

Exit codes scripts can branch on

After every run, check $LASTEXITCODE (PowerShell) or %ERRORLEVEL% (CMD). Full detail: Errors & Exit Codes.

CodeMeaningTypical action
0SuccessJob finished cleanly.
1General errorInspect console / report; unexpected failure.
2Invalid argumentsFix flags or config path before retrying.
3License / activationActivate Full key or use Demo within the 25-item cap.
4Source missing / emptyCheck input path; nothing discovered to process.
5Conversion failedHard job failure—read report before re-queue.
6Partial successBatch mixed results; some files OK—review failed count, then --resume.
7CancelledCtrl+C / cancel; resume later if checkpointed.

Demo vs Full (CLI Automation)

Same Windows CLI binary: Demo evaluates with a 25-item cap; Full unlocks after CLI Automation activation ($1,499). Business/Enterprise GUI licenses do not include the CLI.

Demo

Evaluate on real data

  • All major converters available
  • 25 items per job
  • Menu and direct commands
  • No product-key activation
Download via Migrator hub

WholeClear CLI ships only with the CLI Automation edition of WholeClear Migrator ($1,499). Business and Enterprise cover the desktop GUI only.

Production scenarios

Workloads admins actually schedule—overnight archives, cutovers, and multi-tenant packs.

Overnight archive lift

Hundreds of PSTs to EML or PDF on a Server host with parallel batch workers and resume after a network blip.

Mailbox cutover

Pre-stage IMAP→Microsoft 365 or IMAP→IMAP JSON, run during the window, resume if auth flakes.

MSP multi-client pack

One script, many tenants—swap config paths and env secrets, keep the same exit-code checks.

For a single small file and an operator who only wants a mouse, use the desktop GUI. Use the CLI when volume, Server hosts, or unattended runs matter.

Platform & operating limits

Windows-only binary. Works on Server when you install the same Win-x64 build and drive it from scripts or Task Scheduler.

Supported OS
Windows 10 / 11 (x64). Same Win-x64 build can run on Server hosts—not every Server SKU separately certified.
Not supported
Linux, macOS, non-Windows Docker/containers (unless a Windows guest). Not Windows 7/8.
Headless / Server use
Yes—Task Scheduler, scripts, CI. Interactive menu needs a real console/RDP session.
Windows Service
Not a built-in service. Schedule wholeclear from Task Scheduler or your own wrapper.
NSF / Notes
Windows only: x86 build + working HCL/IBM Notes on that machine. Not on Mac/Linux.
IMAP / Microsoft 365
Outbound network + user credentials/tokens (env vars in JSON). Not Google Admin / domain-admin impersonation or native Exchange.
PDF output
Needs the wkhtmltopdf helper packaged with Full/Demo installers.
License location
Activation / licW.db must be valid on the machine that runs the job (typically under AppData).

Packaging and artifacts

What you get on disk after Setup—installer, reports, activation, and docs.

Windows installerSelf-contained Setup EXE for x64 (x86 for NSF)
Logs & reportsHTML / CSV / JSON under WholeClear-Reports
ActivationCLI Automation key unlocks Full (Demo needs no key)
Docs & samplesCommands, JSON configs, scripting patterns

FAQ

Short answers. Deep flag references stay in the docs.

Does WholeClear CLI run on Windows Server?

Yes—install the same Windows x64 build documented for Windows 10/11, then run convert / batch / migrate from Task Scheduler, PowerShell, or CMD. We do not certify every Server SKU separately. Not Linux/macOS, and not a built-in Windows Service.

How is this different from the WholeClear GUI?

Same conversion engine; different interface. The GUI suits interactive one-off work. The CLI suits batch, scripts, and unattended Windows hosts. Business/Enterprise buy the GUI only; CLI needs CLI Automation (or Demo).

Can we automate it from PowerShell or Python?

Yes. Call wholeclear like any Windows process, use -o json for machine-readable results, and branch on exit codes 0–7. There is no separate Python SDK—your script is the wrapper. See the scripting guide.

Where do passwords go for migrate configs?

Keep passwords and tokens in environment variables referenced from the JSON (for example IMAP password / Graph token env fields)—not as plain text inside the file on disk. Details: Migration JSON.

What happens if a long batch is interrupted?

Use batch with a checkpoint database and --resume (or jobs resume). Already finished files can be skipped on the next run.

Does it support IMAP and Microsoft 365?

Yes. Interactive IMAP download is available from the menu; scripted migrations use JSON configs for IMAP brand presets and Graph/IMAP Microsoft 365 with user credentials or tokens—not domain-admin impersonation or native Exchange.

How do we buy the CLI?

Order the CLI Automation edition ($1,499 one-time) on the Migrator order page. It unlocks WholeClear CLI 11.0 on Windows and includes Enterprise desktop rights. Business/Enterprise alone do not include the CLI.

What are the Demo limits?

The evaluation build processes up to 25 items per job so you can validate formats and workflow. CLI Automation removes that cap after activation.

Start with the Demo, keep the docs open

Install on a Windows 10/11 lab host (or a Server host with the same x64 build), run a small batch or menu convert, then wire the same command into Task Scheduler for production.