Commands

Algorum CLI Commands are the core part of how you as a developer interact with Algorum Platform to develop, test, deploy, monitor and manage your Algo Trading strategies. Below are the list of Algorum CLI Commands and their description.

Command Name	Command Description
apikey-get	Get the existing ApiKey.
apikey-refresh	Creates a new ApiKey. Invalidates the existing ApiKey.
clear \| cls	Clear contents of the screen.
docker-images	List all the docker images on this system.
engine-ip	Display User's Quant Engine IP address.
engine-restart	Restart the Quant Engine.
help	Displays help on list of Algorum CLI commands.
log-adhoc-backtest-download	Download log file for adhoc strategy run.
log-backtest-download	Download strategy backtesting logs.
log-backtest-list	List all backtesting log files for a given strategy.
log-backtest-stream	Stream logs from the strategy backtest.
log-download	Download strategy logs.
log-list	List all the log files for a given strategy.
log-raw-download	Download the raw Algorum Cloud logs of a strategy. These logs do not contain the logs written by your strategy using LogAsync method. These logs contain messages related to any errors in your strategy code, which are not logged using LogAsync method.
log-stream	Stream logs from the strategy.
login	Login or register with Algorum.
quant-engine-version	Shows your quant engine version.
strategy-attach	Attach to a running strategy and receive stats.
strategy-backtest	Backtest a strategy.
strategy-backtest-attach	Attach to a running strategy backtest and receive progress and stats.
strategy-backtest-clear-state	Clear all the state stored by a strategy backtest.
strategy-backtest-clear-state-key	Clear a state key stored by a strategy backtest.
strategy-backtest-get-state	Download all the state stored by a strategy backtest.
strategy-backtest-get-state-list	Get the list of state keys stored by a strategy backtest.
strategy-backtest-get-stats	Download the strategy backtest stats.
strategy-backtest-stop	Stop backtesting of a strategy.
strategy-clear-state	Clear all the state stored by a strategy.
strategy-clear-state-key	Clear a state key stored by a strategy.
strategy-create	Create a new strategy.
strategy-get-state	Download all the state stored by a strategy.
strategy-get-state-list	Get the list of state keys stored by a strategy.
strategy-get-stats	Download the strategy stats.
strategy-info	Get the strategy information.
strategy-list	List all strategies.
strategy-package-push	Push a strategy package to Algorum repository.
strategy-run-download-orders	Download the orders of a given strategy run.
strategy-run-list	Get the list of runs for a given strategy.
strategy-run-summary	Get the summary of a given strategy run.
strategy-start-live-trading	Start a strategy in live trading mode.
strategy-start-paper-trading	Start a strategy in paper trading mode.
strategy-stop	Stop a running strategy.
unregister	Unregister from Algorum.
user-log-download	Download log files of the currently logged in user.
user-log-list	List log files of the currently logged in user.