The apiUi CLI
The command line interface, although most important for apiUiserver, is partly also working for apiUi.
Command line options are:
- port=: set the http port number
- project=: opens the named project
- context=: uses the named context
- help: types a helpmessage
- lstLog=: writes lst information to the named file
- script=: executes the name project-script
- terminate: terminates after executing the named project-script
- trackIO: notifies IO operations
- debug: types full requests and responses
- certsFolder=: openSSL certificates folder
port
apiUiServer only
Set the http port number (default 7777).
Example:
./apiUiServer --port=8888
project
Opens the named project.
Example:
./apiUiServer --project=../project/myresponders.svpr
context
Set the context string with this option.
Example:
./apiUiServer --context=T2
help
apiUiServer only
Types a helpmessage showing all available options.
lstLog
apiUiServer only
writes lst information to the named file
script
Executes the name project-script after opening the project.
Requires that you also specify a project on the command line.
Example:
./apiUiServer --project=../project/myresponders.svpr --script=StartUp
terminate
apiUiServer only
Terminates apiUiServer after executing the named project-script.
Requires that you also specify a project and a script to execute on the command line.
./apiUiServer --project=../project/myresponders.svpr --script=runalltests --terminate
trackIO
apiUiServer only
Notifies IO operations
./apiUiServer --trackIO
debug
apiUiServer only
Types full requests and responses in the console.
./apiUiServer --debug
certsFolder
Specifies where apiUi/apiUiServer should look for OpenSSL certificates.
When certificates are needed and you design your project on Windows but run it on Linux, you often can not use relative filenames.
This command line option will help you out. When you use this switch, then only specify filenames for certificates in Project->Configure listeners.
./apiUiServer --certsFolder=../openssl/certs