Call SEAL OP-CLI Scripts¶
Data Type¶
You can call scripts or show their usage by specifying script
as <dataType>
in the SEAL OP-CLI call:
opcli script <command> <option>
Display the Options and Parameters¶
By specifying the --help
option, you get the available options and parameters for the script
data type:
opcli script --help
Call a Script¶
With the exec
command, you can call a script containing SEAL OP-CLI command:
opcli script exec <name> [--dir <customScriptDir>] [--localfile <fileOrDirectory>`] [-p,--param <key>=<value>]*
-
<name>
: Name of the script; mandatory -
--dir <customScriptDir>
: The directory of the script in case of a custom script; built-in scripts do not need this option -
--localfile <fileOrDirectory>
: Local file to be used or local directory containing files to be used; wildcards are supported -
-p,--param <key>=<value>
: Script-specific parameter; the option can be specified several times; default: none
Example - call the built-in script doThings
with two parameters
opcli script exec doThings -p foo1=bar1 -p foo2=bar2
Example - call the custom script doOtherThings
with one parameters
opcli script exec doOtherThings -dir C:\mydir1\mydir2 -p foo=bar
Show the Usage of a Script¶
With the usage
command, you can show the usage of a script:
opcli script usage <name> [--dir <customScriptDir>]
-
<name>
: Name of the script; mandatory -
--dir <customScriptDir>
: The directory of the script in case of a custom script; built-in scripts do not need this option -
--localfile <fileOrDirectory>
: Local file to be used or local directory containing files to be used; wildcards are supported
Example - show the usage of the print-docs
built-in script
opcli script usage print-docs
Built-in Scripts¶
The following built-in scripts are contained in delivery and ready to use:
-
print-docs
uploads one or more local file(s) to SEAL Operator and outputs them via PLOSSYS 4. -
shopping-cart
uploads a file or all files contained in a directory to the shopping cart panelPLOSSYS Pool
. -
upload-docs
uploads a single local file or all files contained in a local directory to SEAL Operator and creates a new panel which contains the uploaded files. -
upload-rli
uploads a repro list file to SEAL Operator and creates a new panel with the content of the uploaded repro list file.
For more information about the built-in scripts, refer to Call SEAL OP-CLI Built-In Scripts.