Commands

Command Line Interface overview

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

The --console or -c option is required to start CLI mode.

Key	Short key	Meaning	Example	Comment
--console	-c	Start Signal in CLI mode	signal.exe --console	This option is required to start CLI mode
--help	-h	Show the help message	signal.exe --help	This option takes precedence over all others: it displays help and exits
--default		Send the 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 a transaction data file to the host	signal.exe --console --file visa_installment.json
--dir DIR_PATH	-d DIR_PATH	Directory containing transaction files. Signal tries to parse each file and send it to the host	signal.exe --console --dir test_scenarios/visa_smoke_test
--address ADDRESS	-a ADDRESS	Set a custom remote host TCP/IP address	signal.exe --console --default --address 127.0.0.1	Usually combined with --port to specify the remote port
--port REMOTE_PORT	-p REMOTE_PORT	Set a custom remote host port	signal.exe --console --default --port 5665	Usually combined with --address to specify the remote host address
--repeat	-r	Repeat transactions after sending	signal.exe --console --default --repeat
--interval INTERVAL_SEC	-i INTERVAL_SEC	Set the delay between sending transactions	signal.exe --console --default --repeat --interval 10
--parallel		Send the next transaction without waiting for the previous response	signal.exe --console --dir test_scenarios/visa_smoke_test	The example sends all files from test_scenarios/visa_smoke_test without waiting for responses
--log-level LOG_LEVEL	-l LOG_LEVEL	Set the debug level for this run	signal.exe --console --default --log-level DEBUG
--log-file LOG_FILE_PATH		Set a custom log file for this run. The default is common/log/signal.log	signal.exe --console --echo-test --log-file custom_logs/logfile.log	Messages are appended to the log file
--no-print		Suppress screen logging. The log file is written as usual	signal.exe --console --echo-test --no-print	Use --log-level NOTSET to disable logging entirely
--timeout TIMEOUT_SEC	-t TIMEOUT_SEC	Timeout for waiting for a transaction response. Signal handles the timeout when this period expires	signal.exe --console --default --timeout 10
--print-config		Print the configuration file contents at startup	signal.exe --console --default --print-config
--config-file CONFIG_FILE_PATH		Set a custom configuration file for this run	signal.exe --console --default --config-file configuration/custom_config.json
--specification SPECIFICATION	-s SPECIFICATION	Set a custom specification file for this run	signal.exe --console --default --config-file specification/custom_spec.json
--api-mode		Run Signal API in CLI mode	signal.exe --console --api-mode	This option disables transaction-sending options such as --default and --file. It cannot be combined with --repeat
--version	-v	Show the current Signal version	signal.exe --console --version
--about		Show application information	signal.exe --console --about