/
Work with ShogunPostCL

Work with ShogunPostCL

Owned by Adaptavist ScriptRunner for Confluence Cloud (Unlicensed)
Jul 11, 2024
2 min read

ShogunPostCL.exe is a command-line version of Shogun Post and is mainly used as a worker when batch farming multiple files. However, ShogunPostCL can be used outside of batch processing, for example, to use the software to run a script on an input file and then save an output file.

For a full list of arguments or options you can use with ShogunPostCL, enter ShogunPostCL -help into the command line.

Run ShogunPostCL

There are two ways to run ShogunPostCL:

Via the .exe file:

  1. Go to C:\Program Files\Vicon\ShogunPost1.1#.

  2. Double-click on ShogunPostCL.exe.

Via the command line:

  1. Open the command prompt (type CMD into the search feature of the Windows taskbar).

  2. Change the directory to C:\Program Files\Vicon\ShogunPost1.1#.

  3. Enter ShogunPostCL.

ShogunPostCL modes

You can run ShogunPostCL in the following modes.

Run ShogunPostCL in Batch mode

Batch mode is a legacy mode from older versions of ShogunPostCL. We do not advise using ShogunPostCL in Batch mode as it is easier to run processes using the user interface in Shogun Post.

However, if you need to use the legacy mode, enter the following command to run ShogunPostCL in Batch mode.

ShogunPostCL -batch FilePath

This mode processes files based on the batch values in an .ini file. Provide the file path to the .ini file containing the batch files.

Run ShogunPostCL in Slave mode

You need to put ShogunPostCL into worker mode if you are using ShogunPostCL as a worker whilst processing multiple files with a batch farm.

Enter the following command to run ShogunPostCL in worker mode.

ShogunPostCL-slave WorkgroupNamePort

Find the name of the work group port in the instance of Shogun Post you are using as the controller of the batch farm. Open the Batching panel, expand the Farm section, and view the name of the WorkgroupNamePort in Work Group.

For more information on batch farming, see Batch process files in Shogun Post.

Run ShogunPostCL in Old mode

This mode processes files using a given HSL script. Enter the following command to run ShogunPostCL in Old mode.

ShogunPostCL -old "InFile" "Script" "OutFile"

Where:

-old - Runs ShogunPostCL in the original ShogunPostCL processing mode

"InFile" – The path to the file to process, including the name of the file

"Script" – The name of the HSL script to use

"OutFile" – The path to where you want to save the processed file, including the name of the file

Related content