Command-line reference

Each call to the command-line tool must respect this syntax:

PVsystCLI.exe <command> <options>

Here is the list of all available commands and their options.

help

Get help on a specific command or list all available commands.

Usage:

PVsystCLI.exe help <command>

Example commands:

PVsystCLI.exe help

This will output all available commands.

PVsystCLI.exe help convert-meteo

This will output the help documentation for the convert-meteo command.

version

This command will return the current version of the program and will check for updates of the current version. If a new update is available, this command will return the URL to download it.

Usage:

PVsystCLI.exe version

Example outputs:

PVsystCLI 8.0.12
PVsystCLI is up to date, you are using the latest version

A new release for PVsystCLI is available: 8.0.12
You can download and install it from here: ../download/latest  

lic-activate

Operate on the license to activate it. This command requires the license key to be passed as parameter.

Usage:

PVsystCLI.exe lic-activate <options>

Options:

Example command:

PVsystCLI.exe lic-activate --key:xxx-xxxxxxxxxxxxxxxxxxxxxxxx

Output codes:

lic-sync

This command will synchronize the license with the server to update its information or end date. Use this command to update a license which has been renewed for example.

Example command:

PVsystCLI.exe lic-sync

lic-deactivate

This command will deactivate the license from the current computer. This action is required when the license needs to be activated on another machine.

Usage:

PVsystCLI.exe lic-deactivate <options>

Options:

Example command:

PVsystCLI.exe lic-deactivate --customer-id:xxxxxxxx

Example output:

Deactivating PVsystCLI license xxx-xxxxxxxxxxxxxxxxxxxxxxxx
PVsystCLI license successfully deactivated from this machine

lic-info

This action will output the current license status, validity date with the format "YYYY-MM-DD" and any other license related information.

Usage:

PVsystCLI.exe lic-info

Example output:

License file: C:\ProgramData\PVsystCLI\PVsystCLI.lic
License key: xxx-xxxxxxxxxxxxxxxxxxxxxxxx
Licensee: Company name
Host ID: HARDDISK=XXX, ETHERNET=XXX, WIN_PRODUCT_ID=XXX, BIOS=XXX
Expiration date: 2025-07-01, 226 days remaining

convert-meteo

This action can be used to convert a CSV meteorological data file to a .MET file.

Usage:

PVsystCLI.exe convert-meteo <options>

Options:

Example usage:

PVsystCLI.exe convert-meteo -input-csv-file:Input.CSV -input-mef-file:Format.MEF -input-sit-file:Geneva.SIT -output-met-file:OutputFile.MET

run-simulation

This command will run a PVsyst simulation and generate the output report and results.

Usage:

PVsystCLI.exe run-simulation <options>

Options:

NB: The advanced parameters file specified in the --input-param-file option should be edited from the PVsyst interface. The modified parameters list can be found at the following address : <USERNAME>\AppData\Local\PVsyst\8.0\Admin\Param_Modif.dat

Usage examples:

Running variant VC0 of project Geneva located in C:\PVsyst8.0_Data:

PVsystCLI.exe run-simulation --workspace:"C:\PVsyst8.0_Data" --project:"Geneva" --variant:"VC0"

Running variant VC0 of project Geneva located in C:\PVsyst8.0_Data for January 2024, and output the report to C:\Downloads\PVsystReport.pdf :

PVsystCLI.exe run-simulation -w:"C:\PVsyst8.0_Data" -p:"Geneva.PRJ" -v:"VC0" -sd:2024-01-01 -ed:2024-01-31 -rpf:"C:\Downloads\PVsystReport.pdf"

Running multiple simulations with different parameters defined in BatchsParams_0.csv based on variant VC0 of project Geneva located in C:\PVsyst8.0_Data. Output variables are defined in BatchsVariables.rvt and results will be generated in BatchsResults_0.csv :

PVsystCLI.exe run-simulation -w:"C:\PVsyst8.0_Data" -p:"Geneva.PRJ" -v:"VC0" -bpf:"C:\PVsyst8.0_Data\UserBatch\BatchsParams_0.csv" -brf:"C:\PVsyst8.0_Data\Params\BatchsVariables.rvt"

Example output:

Checking license...
Loading workspace C:\PVsyst8.0_Data...
Loading project Geneva...
Loading variant VC0...

export-logs

This command will export the PVsystCLI logs which can be sent to the support for better investigating issues.

Usage:

PVsystCLI.exe export-logs <options>

Options:

Example usage:

PVsystCLI.exe export-logs

PVsystCLI.exe export-logs --target-folder:"C:\Logs"

Example output:

Exporting logs to C:\Logs ...
Logs ZIP file successfully created: C:\Logs\2024_05_17-15_40_45-PVsystCLI800-logs.zip