CLI
Use Zenovix CLI for read-only Pro reporting.
Zenovix CLI is a safe command line interface for storage analysis,
reporting, scheduled scans, Storage History Workbooks and exports.
It is available with Zenovix Pro and is designed to complement the
desktop application, not replace it.
CLI
Overview
What Zenovix CLI is for
Use the CLI when you need repeatable Windows storage CLI analysis,
PowerShell storage reporting, scheduled storage analysis, NAS
storage analysis, UNC storage scanning, Storage History Workbooks
or export files for Excel, Power BI and other reporting tools.
- Available with Zenovix Pro.
- Runs read-only storage analysis and reporting commands.
- Works with folders, drives, UNC paths, NAS devices and mapped drives.
- Can write JSON, CSV, XLSX, Storage History Workbook and ODBC database output.
- Can be called from PowerShell, scripts and Windows Task Scheduler.
- Free users can run
zenovix --help and zenovix --version.
SAFE
Safety model
The CLI never performs cleanup
The CLI is read-only by design. This is intentional: command line
automation is useful for analysis and reporting, but cleanup should
stay inside the desktop application where review state, archive
choices, restore previews and recovery records are visible.
- Zenovix CLI never deletes files.
- Zenovix CLI never archives files.
- Zenovix CLI never restores files.
- Zenovix CLI never renames files.
- Zenovix CLI never moves files.
- Zenovix CLI never cleans folders or performs automatic cleanup.
- Destructive command names such as
delete, archive, restore, cleanup, clean, remove, move, rename, empty-recycle-bin, dedupe and fix are refused.
- Use the desktop application for review-first cleanup, archive, restore and Recovery Centre workflows.
01
Installation
Use the Microsoft Store app execution alias
Install or update Zenovix Storage Manager from the Microsoft Store.
The Store package includes the zenovix.exe execution
alias, so the command can be launched as zenovix from
Windows Terminal, PowerShell, Command Prompt or Task Scheduler.
zenovix --help
zenovix --version
- If Windows cannot find
zenovix, check Windows Settings > Apps > Advanced app settings > App execution aliases.
- If Pro cannot be verified, functional commands fail safely before scanning and explain that Zenovix Pro could not be verified.
- Free and unknown licence states can still show help and version output, but functional commands require Pro.
The general command format is:
zenovix <command> [arguments] [options]
- Global options:
--help, -h, --version, --quiet, --json and --log <file>.
- Pro functional commands:
scan, compare, top, health, history, export and profile.
- Reserved product names such as summary, growth, duplicates and insights are not documented as public commands until they are implemented.
03
Scan
Run storage scans from the command line
zenovix scan <path> [<path> ...] [options]
scan runs storage analysis over folders, drives, UNC
paths, NAS devices or mapped drives. Use it for scheduled reports,
workbook history and export generation.
- File-report options include
--history <file.xlsx>, --output <folder>, --json, --csv and --xlsx.
- ODBC output uses
--output odbc --connection <DSN-or-connection-string>. Add --report-output <folder> when combined JSON, CSV or XLSX report files need a destination.
- Scan options also include
--fast, --analysis, --top-folders <n>, --include <pattern>, --exclude <pattern>, --recursive true|false, --quiet and --log <file>.
zenovix scan D:\Photos
zenovix scan "\\server\Finance" --analysis --history "Storage History.xlsx"
zenovix scan D:\Data --json
zenovix scan D:\Data --xlsx --output "C:\Reports" --top-folders 25
zenovix scan D:\Data --output odbc --connection "ZenovixHistory"
zenovix scan D:\Data --output odbc --connection "ZenovixHistory" --xlsx --report-output "C:\Reports"
04
Reports
Compare, rank and export scan data
zenovix compare --history <file.xlsx> [options]
zenovix top folders|files|extensions <path> [options]
zenovix top folders|extensions --history <file.xlsx> [options]
zenovix export --history <file.xlsx> [--json] [--csv] [--xlsx] [--output <folder>]
compare compares the latest scan against the previous scan in a Storage History Workbook.
top shows largest folders, files or extensions from a path or workbook.
export exports the most recent scan stored in a Storage History Workbook.
- Use
--count <n>, --json, --quiet and --log <file> where supported.
05
History Workbook
Keep storage history without deleting old data
zenovix history info [--history <file.xlsx>] [--json]
zenovix history validate [--history <file.xlsx>] [--json]
zenovix history init [--history <file.xlsx>]
zenovix history repair [--history <file.xlsx>]
- Storage History Workbooks are XLSX files designed for repeated storage analysis over time.
- The workbook can be opened in Excel-compatible tools and analysed in Power BI.
- Zenovix CLI can create and append workbook data without requiring Microsoft Excel to be installed.
history repair manages workbook structure without deleting or rewriting historical scan data.
PROFILE
Saved profiles
Run a desktop scan plan by its stable ID
zenovix profile run <profile-id> [--quiet] [--log <file>]
profile run executes a profile created in the desktop Scheduled Scan Plans window.
- The saved profile supplies its scan paths, filters, history workbook, JSON/CSV/XLSX reports and optional ODBC destination.
- Windows Task Scheduler only needs the stable profile ID, so profile settings and ODBC connection details are not placed on the scheduled task command line.
- Scan and output options cannot be overridden on
profile run; edit the saved plan in the desktop app instead.
zenovix profile run 63fc6e99-42f7-47a7-9972-83ec998aab31 --quiet
06
Health
Check scan readiness before scheduling a job
zenovix health <path> [options]
health checks whether a path can be scanned.
- It reports access, skipped files, long paths, scan speed and a read-throughput estimate.
- Options include
--json, --quiet and --log <file>.
07
Automation
PowerShell and Task Scheduler examples
Use PowerShell for ad-hoc reporting and Task Scheduler for
repeatable scan jobs.
zenovix scan D:\Data --json | Out-File "C:\Reports\latest-storage.json" -Encoding utf8
zenovix top folders --history "C:\Reports\Storage History.xlsx" --count 20 --json
Program/script: zenovix
Arguments: scan "D:\Data" --history "C:\Reports\Storage History.xlsx" --xlsx --output "C:\Reports" --quiet --log "C:\Reports\zenovix.log"
- Use quoted paths for folders, network shares and workbook paths that contain spaces.
- Use
--quiet for scheduled jobs where you only want files and logs.
- Use
--log <file> to append execution log lines for later troubleshooting.
08
Outputs
JSON, CSV, XLSX, workbook and ODBC output
- Use
--json when scripts or monitoring tools need structured output on stdout.
- Use
--csv for lightweight tabular exports.
- Use
--xlsx for Excel-compatible reports and Storage History Workbook workflows.
- Use
--output <folder> to choose where exported files should be written.
- Use
--history <file.xlsx> when a scan should append to or read from a workbook.
- Use
--output odbc --connection <value> to append an immutable scan snapshot to an ODBC database. The value can be a DSN name or a full ODBC connection string.
- Use
--report-output <folder> for JSON, CSV or XLSX report files when --output odbc occupies the output option.
- ODBC output can be combined with
--history, --json, --csv and --xlsx; all destinations use the same completed scan snapshot.
09
Exit codes
Automation-friendly results
0 - success.
1 - invalid arguments or refused destructive command.
2 - scan or command failed.
3 - access denied.
4 - workbook failure.
5 - internal error.
6 - Zenovix Pro required or Pro status could not be verified.
7 - ODBC connection, schema or database write failed and the transaction was rolled back.
8 - JSON, CSV or XLSX report export failed after the scan completed.
FAQ
More help
Related FAQ topics
See the CLI FAQ for common
questions about Free and Pro access, PowerShell, Task Scheduler,
NAS devices, UNC paths, Excel, Power BI and why cleanup remains a
desktop workflow.