diff --git a/docs/utils.md b/docs/utils.md index 3d6eda3ce..eb675442f 100644 --- a/docs/utils.md +++ b/docs/utils.md @@ -947,6 +947,7 @@ Common arguments: --userdir PATH, --user-data-dir PATH Path to userdata directory. ``` + ### Examples Print trades with id 2 and 3 as json @@ -956,11 +957,45 @@ freqtrade show-trades --db-url sqlite:///tradesv3.sqlite --trade-ids 2 3 --print ``` ### Strategy-Updater -Updates a list strategies or all strategies within the strategies folder to be v3 compliant including futures. -If the command runs without --strategy-list then all files inside the strategies folder will be converted. -``` -usage: freqtrade strategy_updater -optional arguments: - --strategy-list defines a list of strategies that should be converted +Updates listed strategies or all strategies within the strategies folder to be v3 compliant. +If the command runs without --strategy-list then all strategies inside the strategies folder will be converted. +Your original strategy will remain available in the `user_data/strategies_orig_updater/` directory. + +!!! Warning "Conversion results" + Strategy updater will work on a "best effort" approach. Please do your due diligence and verify the results of the conversion. + We also recommend to run a python formatter (e.g. `black`) to format results in a sane manner. + +``` +usage: freqtrade strategy-updater [-h] [-v] [--logfile FILE] [-V] [-c PATH] + [-d PATH] [--userdir PATH] + [--strategy-list STRATEGY_LIST [STRATEGY_LIST ...]] + +options: + -h, --help show this help message and exit + --strategy-list STRATEGY_LIST [STRATEGY_LIST ...] + Provide a space-separated list of strategies to + backtest. Please note that timeframe needs to be set + either in config or via command line. When using this + together with `--export trades`, the strategy-name is + injected into the filename (so `backtest-data.json` + becomes `backtest-data-SampleStrategy.json` + +Common arguments: + -v, --verbose Verbose mode (-vv for more, -vvv to get all messages). + --logfile FILE, --log-file FILE + Log to the file specified. Special values are: + 'syslog', 'journald'. See the documentation for more + details. + -V, --version show program's version number and exit + -c PATH, --config PATH + Specify configuration file (default: + `userdir/config.json` or `config.json` whichever + exists). Multiple --config options may be used. Can be + set to `-` to read config from stdin. + -d PATH, --datadir PATH, --data-dir PATH + Path to directory with historical backtesting data. + --userdir PATH, --user-data-dir PATH + Path to userdata directory. + ``` diff --git a/freqtrade/commands/arguments.py b/freqtrade/commands/arguments.py index a3cdc378a..9b714a864 100644 --- a/freqtrade/commands/arguments.py +++ b/freqtrade/commands/arguments.py @@ -116,7 +116,7 @@ NO_CONF_REQURIED = ["convert-data", "convert-trade-data", "download-data", "list NO_CONF_ALLOWED = ["create-userdir", "list-exchanges", "new-strategy"] -ARGS_STRATEGY_UTILS = ARGS_COMMON_OPTIMIZE + ["strategy_list"] +ARGS_STRATEGY_UTILS = ["strategy_list"] class Arguments: diff --git a/requirements.txt b/requirements.txt index 7607a3664..a0ff8e03a 100644 --- a/requirements.txt +++ b/requirements.txt @@ -56,4 +56,4 @@ schedule==1.1.0 websockets==10.4 janus==1.0.0 -ast-comments>=1.0.0 +ast-comments==1.0.0