Commands

Command Line Interface overview

To start the Signal in CLI mode use command signal.exe --console [other_commands]

Key --console or -c is required to start CLI

Key	Short key	Meaning	Example	Comment
--console	-c	Start the Signal in CLI mode use command	signal.exe --console	This key is required to start CLI
--help	-h	Get help message	signal.exe --help	This key blocks all the others, shows help message and interrutpt the work not depending on the other keys
--default		Send default message to the host	signal.exe --console --default
--echo-test		Send echo-test to the host	signal.exe --console --echo-test
--file FILE_PATH	-f FILE_PATH	Parse and send transaction data file to the host	signal.exe --console --file visa_installment.json
--dir DIR_PATH	-d DIR_PATH	Directory with transaction files to parse. Signal will try to parse them one by one and send to the host	signal.exe --console --dir test_scenarios/visa_smoke_test
--address ADDRESS	-a ADDRESS	Set custom remote host TCP/IP address	signal.exe --console --default --address 127.0.0.1	Usually combines with --port to specify remote port
--port REMOTE_PORT	-p REMOTE_PORT	Set custom remote host port	signal.exe --console --default --port 5665	Usually combines with --address to specify remote host address
--repeat	-r	Repeat transactions after sending	signal.exe --console --default --repeat
--interval INTERVAL_SEC	-i INTERVAL_SEC	Set delay between transactions sending	signal.exe --console --default --repeat --interval 10
--parallel		Send new transaction with no waiting of answer for previous one	signal.exe --console --dir test_scenarios/visa_smoke_test	Commmand from example will send all the files from directory test_scenarios/visa_smoke_test without waiting for answer
--log-level LOG_LEVEL	-l LOG_LEVEL	Set debug level for this call	signal.exe --console --default --log-level DEBUG
--log-file LOG_FILE_PATH		Set custom logfile for this call. Default one is common/log/signal.log	signal.exe --console --echo-test --log-file custom_logs/logfile.log	Logfile will be used in append mode
--no-print		Do not print the log to the screen. Logfile will be written as usual	signal.exe --console --echo-test --no-print	Use key --log-level NOTSET if you need to not write log at all
--timeout TIMEOUT_SEC	-t TIMEOUT_SEC	Timeout of waiting transaction response. After the Signal will trigger the timeout processing scenario	signal.exe --console --default --timeout 10
--print-config		Print configuration file content when start work	signal.exe --console --default --print-config
--config-file CONFIG_FILE_PATH		Set custom configuration file for this call	signal.exe --console --default --config-file configuration/custom_config.json
--specification SPECIFICATION	-s SPECIFICATION	Set custom specification file for this call	signal.exe --console --default --config-file specification/custom_spec.json
--api-mode		Run Signal API in CLI mode	signal.exe --console --api-mode	This key blocks all the transaction send key-commands such as --default, --file, etc. Does not work together with --repeat key
--version	-v	Show current version of the SIgnal	signal.exe --console --version
--about		Show About message	signal.exe --console --about