This is beta documentation. View the latest stable documentation.

Command Line

This article describes the current command line options for Pano2VR.

pano2vr [options] [-x] [-t <filename.p2vr>] <input file> <input file> ...
pano2vr --cli [options] [-t <filename.p2vr>] <input file> <input file> ...

<input file>: An image or other file format supported as an input for Pano2VR (Supported Formats), or a .p2vr project file. When you give a folder, Pano2VR uses all supported images in it (not in the command line mode described below).

Without -x or --cli, Pano2VR opens the files for editing.

Options

-x: Executes the following input files. If the input file is a .p2vr file, the result is the same as clicking the Generate Output button for every output of the project. Pano2VR quits when the export is done.

-t <filename.p2vr>: Selects a .p2vr file as a template. For all subsequent input images a Generate Output is executed on this image. The input section in the template file is ignored. This is how droplets work.

--createtour: Assembles all input images into a single tour instead of processing the images one by one.

--autolink: Tries to automatically link the nodes of a tour if GPS data is present in the EXIF or XMP data. Use it together with --createtour.

--createprojectfile: Stores a project file next to the input images. It has no effect on .p2vr input files, so an existing project is never overwritten.

--nogui: Exports without showing the progress dialog. Errors are written to the standard error output instead, such as a skin that doesn’t exist or a panorama image that is missing or can’t be opened, with its file name. --cli writes its errors there too.

--foreground: Brings the progress dialog to the front.

--nows: Starts Pano2VR without the welcome screen.

-s <folder>: Opens the Integrated Web Server and serves this folder.

--debug: Writes debug messages to the file pano2vr.log in the current working folder.

-V: Prints the version and build number of Pano2VR and quits.

Command Line Mode

--cli: Runs Pano2VR without its graphical interface, for example on a build server or in a script. Every .p2vr file given is exported, so -x is not needed; images are processed with the template given with -t. --createtour, --autolink, --createprojectfile, and --debug work as described above. Without a license key, Pano2VR exports as the trial version, with all of its marks.

--outputlist: Together with --cli, prints the output file of every output of the given .p2vr files instead of exporting them. For a web output, this is the HTML file. A project that can’t be opened returns the exit code 1.

Exit Codes

When Pano2VR exports from the command line, it returns an exit code that scripts and CI pipelines can check:

0 – All outputs were generated successfully.
1 – An export failed, for example because of a missing input file, or a project can’t be opened. Pano2VR still generates the remaining outputs of the project.
2 – The export was cancelled in the progress dialog.
99 – Only with --cli: the stored license key isn’t valid, for example because a subscription has expired. Without any license key, Pano2VR exports as the trial version instead.

Environment Variables

PANO2VR_SETTINGS: The path of a settings file (.ini) that Pano2VR uses instead of your own settings. Pano2VR reads the file when it starts and writes its settings back to it when it quits. If the file doesn’t exist yet, Pano2VR starts with the default settings and creates it. This keeps a build server or an automated test independent of the settings of the account it runs under.

PANO2VR_SETTINGS=/path/to/settings.ini pano2vr --cli project.p2vr

On Windows, set the variable before you start Pano2VR, for example with set PANO2VR_SETTINGS=C:\path\to\settings.ini in the Command Prompt.

Pano2VR looks for the license key in this file only, so a file without a key runs Pano2VR as the trial version. To use your license with it, start Pano2VR with the variable set and add the license key in the Settings: Pano2VR stores it in the file.