Workbook Compare Pro
HomeHelpRun saved checks from the command line

Workbook Compare Pro · Help

Run saved checks from the command line

Open a project, run a suite, and use exit codes in an automated report check.

For the Windows app · Version 0.9.16

Test the saved suite in the app first

Save and run your suite interactively before automating it. Confirm that the file locations, ignore rules, and reports are right. Automated comparisons require a valid license or an active trial too.

Use the full path to the installed executable on your computer. These examples use a generic program folder; replace it with your actual location. In PowerShell, the leading & runs a quoted executable path.

Commands you can use

Open a saved project without running it:

& "C:\Apps\Workbook Compare Pro\Workbook Compare Pro.exe" --open-project "C:\Tests\Daily.wcp"

Open a suite for review:

& "C:\Apps\Workbook Compare Pro\Workbook Compare Pro.exe" --open-suite "C:\Tests\Daily.wcps"

Run enabled projects, write reports, and close:

& "C:\Apps\Workbook Compare Pro\Workbook Compare Pro.exe" --run-suite "C:\Tests\Daily.wcps" --report-folder "C:\Tests\Reports" --csv

Add --quiet once you have tested it visibly. Use --help for the command reference.

Options and output

OptionPurpose
--open-project PATHLoad a .wcp project without automatically comparing.
--open-suite PATHLoad a .wcps suite without running it.
--run-suite PATHRun the enabled projects, write a dated HTML report, and close.
--report-folder PATHChoose the report folder. Otherwise, reports go in Workbook Compare Pro Reports beside the suite.
--csvAlso write a compact suite summary CSV.
--quietHide the application window during the automated run.
--helpShow the command reference.

Check the exit code

CodeMeaning
0All enabled projects passed.
1A difference or missing/new file was found.
2A project, file, suite, or application error prevented a reliable result.

Keep the report along with the exit code. It explains which project failed and whether the problem was a changed report or a file that could not be checked.

Schedule a run in Windows

  1. Open Task Scheduler and choose Create Basic Task.
  2. Name the task and choose when it should run.
  3. Choose Start a program. Browse to the application executable.
  4. In Add arguments, enter --run-suite "C:\Tests\Daily.wcps" --csv --quiet.
  5. Set Start in to the application folder, without quotes.
  6. Finish, then select the task and click Run to test it. Confirm a new dated report was created.

The account running the task needs access to the app, license, source files, saved projects, and report folder. Network drive letters may not exist in that account’s session; use accessible UNC paths when appropriate. This is a Windows desktop application using WebView2, not a Windows service or a headless server tool.

Still have a question?

Tell us what you are trying to check and where you got stuck. Contact us.