mohammadian7/freqtrade
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update command partials to be created with python 3.13

Browse Source
This commit is contained in:
Matthias
2025-11-09 08:07:37 +01:00
parent e26c3cbe5a
commit 5d494eac51
33 changed files with 182 additions and 222 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/commands/backtesting-analysis.md
+6 -7
View File
@@ -15,13 +15,13 @@ usage: freqtrade backtesting-analysis [-h] [-v] [--no-color] [--logfile FILE]
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
--backtest-filename PATH, --export-filename PATH --backtest-filename, --export-filename PATH
Use this filename for backtest results.Example: Use this filename for backtest results.Example:
`--backtest- `--backtest-
filename=backtest_results_2020-09-27_16-20-48.json`. filename=backtest_results_2020-09-27_16-20-48.json`.
Assumes either `user_data/backtest_results/` or Assumes either `user_data/backtest_results/` or
`--export-directory` as base directory. `--export-directory` as base directory.
--backtest-directory PATH, --export-directory PATH --backtest-directory, --export-directory PATH
Directory to use for backtest results. Example: Directory to use for backtest results. Example:
`--export-directory=user_data/backtest_results/`. `--export-directory=user_data/backtest_results/`.
--analysis-groups {0,1,2,3,4,5} [{0,1,2,3,4,5} ...] --analysis-groups {0,1,2,3,4,5} [{0,1,2,3,4,5} ...]
@@ -54,21 +54,20 @@ Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file. useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more 'syslog', 'journald'. See the documentation for more
details. details.
-V, --version show program's version number and exit -V, --version show program's version number and exit
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH -d, --datadir, --data-dir PATH
Path to the base directory of the exchange with Path to the base directory of the exchange with
historical backtesting data. To see futures data, use historical backtesting data. To see futures data, use
trading-mode additionally. trading-mode additionally.
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
``` ```
docs/commands/backtesting-show.md
+6 -7
View File
@@ -8,13 +8,13 @@ usage: freqtrade backtesting-show [-h] [-v] [--no-color] [--logfile FILE] [-V]
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
--backtest-filename PATH, --export-filename PATH --backtest-filename, --export-filename PATH
Use this filename for backtest results.Example: Use this filename for backtest results.Example:
`--backtest- `--backtest-
filename=backtest_results_2020-09-27_16-20-48.json`. filename=backtest_results_2020-09-27_16-20-48.json`.
Assumes either `user_data/backtest_results/` or Assumes either `user_data/backtest_results/` or
`--export-directory` as base directory. `--export-directory` as base directory.
--backtest-directory PATH, --export-directory PATH --backtest-directory, --export-directory PATH
Directory to use for backtest results. Example: Directory to use for backtest results. Example:
`--export-directory=user_data/backtest_results/`. `--export-directory=user_data/backtest_results/`.
--show-pair-list Show backtesting pairlist sorted by profit. --show-pair-list Show backtesting pairlist sorted by profit.
@@ -26,21 +26,20 @@ Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file. useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more 'syslog', 'journald'. See the documentation for more
details. details.
-V, --version show program's version number and exit -V, --version show program's version number and exit
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH -d, --datadir, --data-dir PATH
Path to the base directory of the exchange with Path to the base directory of the exchange with
historical backtesting data. To see futures data, use historical backtesting data. To see futures data, use
trading-mode additionally. trading-mode additionally.
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
``` ```
docs/commands/backtesting.md
+10 -12
View File
@@ -23,7 +23,7 @@ usage: freqtrade backtesting [-h] [-v] [--no-color] [--logfile FILE] [-V]
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
-i TIMEFRAME, --timeframe TIMEFRAME -i, --timeframe TIMEFRAME
Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`). Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`).
--timerange TIMERANGE --timerange TIMERANGE
Specify what timerange of data to use. Specify what timerange of data to use.
@@ -38,7 +38,7 @@ options:
setting. setting.
--fee FLOAT Specify fee ratio. Will be applied twice (on trade --fee FLOAT Specify fee ratio. Will be applied twice (on trade
entry and exit). entry and exit).
-p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...] -p, --pairs PAIRS [PAIRS ...]
Limit command to these pairs. Pairs are space- Limit command to these pairs. Pairs are space-
separated. separated.
--eps, --enable-position-stacking --eps, --enable-position-stacking
@@ -53,7 +53,7 @@ options:
pairlist will be generated for each new candle if pairlist will be generated for each new candle if
you're using a pairlist handler that supports this you're using a pairlist handler that supports this
feature, for example, ShuffleFilter. feature, for example, ShuffleFilter.
--dry-run-wallet DRY_RUN_WALLET, --starting-balance DRY_RUN_WALLET --dry-run-wallet, --starting-balance DRY_RUN_WALLET
Starting balance, used for backtesting / hyperopt and Starting balance, used for backtesting / hyperopt and
dry-runs. dry-runs.
--timeframe-detail TIMEFRAME_DETAIL --timeframe-detail TIMEFRAME_DETAIL
@@ -68,13 +68,13 @@ options:
becomes `backtest-data-SampleStrategy.json` becomes `backtest-data-SampleStrategy.json`
--export {none,trades,signals} --export {none,trades,signals}
Export backtest results (default: trades). Export backtest results (default: trades).
--backtest-filename PATH, --export-filename PATH --backtest-filename, --export-filename PATH
Use this filename for backtest results.Example: Use this filename for backtest results.Example:
`--backtest- `--backtest-
filename=backtest_results_2020-09-27_16-20-48.json`. filename=backtest_results_2020-09-27_16-20-48.json`.
Assumes either `user_data/backtest_results/` or Assumes either `user_data/backtest_results/` or
`--export-directory` as base directory. `--export-directory` as base directory.
--backtest-directory PATH, --export-directory PATH --backtest-directory, --export-directory PATH
Directory to use for backtest results. Example: Directory to use for backtest results. Example:
`--export-directory=user_data/backtest_results/`. `--export-directory=user_data/backtest_results/`.
--breakdown {day,week,month,year,weekday} [{day,week,month,year,weekday} ...] --breakdown {day,week,month,year,weekday} [{day,week,month,year,weekday} ...]
@@ -91,26 +91,24 @@ Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file. useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more 'syslog', 'journald'. See the documentation for more
details. details.
-V, --version show program's version number and exit -V, --version show program's version number and exit
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH -d, --datadir, --data-dir PATH
Path to the base directory of the exchange with Path to the base directory of the exchange with
historical backtesting data. To see futures data, use historical backtesting data. To see futures data, use
trading-mode additionally. trading-mode additionally.
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
Strategy arguments: Strategy arguments:
-s NAME, --strategy NAME -s, --strategy NAME Specify strategy class name which will be used by the
Specify strategy class name which will be used by the
bot. bot.
--strategy-path PATH Specify additional strategy lookup path. --strategy-path PATH Specify additional strategy lookup path.
--recursive-strategy-search --recursive-strategy-search
docs/commands/convert-data.md
+11 -12
View File
@@ -1,17 +1,17 @@
``` ```
usage: freqtrade convert-data [-h] [-v] [--no-color] [--logfile FILE] [-V] usage: freqtrade convert-data [-h] [-v] [--no-color] [--logfile FILE] [-V]
[-c PATH] [-d PATH] [--userdir PATH] [-c PATH] [-d PATH] [--userdir PATH]
[-p PAIRS [PAIRS ...]] --format-from [-p PAIRS [PAIRS ...]]
{json,jsongz,feather,parquet} --format-to --format-from {json,jsongz,feather,parquet}
{json,jsongz,feather,parquet} [--erase] --format-to {json,jsongz,feather,parquet}
[--exchange EXCHANGE] [--erase] [--exchange EXCHANGE]
[-t TIMEFRAMES [TIMEFRAMES ...]] [-t TIMEFRAMES [TIMEFRAMES ...]]
[--trading-mode {spot,margin,futures}] [--trading-mode {spot,margin,futures}]
[--candle-types {spot,futures,mark,index,premiumIndex,funding_rate} [{spot,futures,mark,index,premiumIndex,funding_rate} ...]] [--candle-types {spot,futures,mark,index,premiumIndex,funding_rate} [{spot,futures,mark,index,premiumIndex,funding_rate} ...]]
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
-p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...] -p, --pairs PAIRS [PAIRS ...]
Limit command to these pairs. Pairs are space- Limit command to these pairs. Pairs are space-
separated. separated.
--format-from {json,jsongz,feather,parquet} --format-from {json,jsongz,feather,parquet}
@@ -21,10 +21,10 @@ options:
--erase Clean all existing data for the selected --erase Clean all existing data for the selected
exchange/pairs/timeframes. exchange/pairs/timeframes.
--exchange EXCHANGE Exchange name. Only valid if no config is provided. --exchange EXCHANGE Exchange name. Only valid if no config is provided.
-t TIMEFRAMES [TIMEFRAMES ...], --timeframes TIMEFRAMES [TIMEFRAMES ...] -t, --timeframes TIMEFRAMES [TIMEFRAMES ...]
Specify which tickers to download. Space-separated Specify which tickers to download. Space-separated
list. Default: `1m 5m`. list. Default: `1m 5m`.
--trading-mode {spot,margin,futures}, --tradingmode {spot,margin,futures} --trading-mode, --tradingmode {spot,margin,futures}
Select Trading mode Select Trading mode
--candle-types {spot,futures,mark,index,premiumIndex,funding_rate} [{spot,futures,mark,index,premiumIndex,funding_rate} ...] --candle-types {spot,futures,mark,index,premiumIndex,funding_rate} [{spot,futures,mark,index,premiumIndex,funding_rate} ...]
Select candle type to convert. Defaults to all Select candle type to convert. Defaults to all
@@ -34,21 +34,20 @@ Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file. useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more 'syslog', 'journald'. See the documentation for more
details. details.
-V, --version show program's version number and exit -V, --version show program's version number and exit
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH -d, --datadir, --data-dir PATH
Path to the base directory of the exchange with Path to the base directory of the exchange with
historical backtesting data. To see futures data, use historical backtesting data. To see futures data, use
trading-mode additionally. trading-mode additionally.
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
``` ```
docs/commands/convert-trade-data.md
+7 -8
View File
@@ -1,14 +1,14 @@
``` ```
usage: freqtrade convert-trade-data [-h] [-v] [--no-color] [--logfile FILE] usage: freqtrade convert-trade-data [-h] [-v] [--no-color] [--logfile FILE]
[-V] [-c PATH] [-d PATH] [--userdir PATH] [-V] [-c PATH] [-d PATH] [--userdir PATH]
[-p PAIRS [PAIRS ...]] --format-from [-p PAIRS [PAIRS ...]]
{json,jsongz,feather,parquet,kraken_csv} --format-from {json,jsongz,feather,parquet,kraken_csv}
--format-to {json,jsongz,feather,parquet} --format-to {json,jsongz,feather,parquet}
[--erase] [--exchange EXCHANGE] [--erase] [--exchange EXCHANGE]
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
-p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...] -p, --pairs PAIRS [PAIRS ...]
Limit command to these pairs. Pairs are space- Limit command to these pairs. Pairs are space-
separated. separated.
--format-from {json,jsongz,feather,parquet,kraken_csv} --format-from {json,jsongz,feather,parquet,kraken_csv}
@@ -23,21 +23,20 @@ Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file. useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more 'syslog', 'journald'. See the documentation for more
details. details.
-V, --version show program's version number and exit -V, --version show program's version number and exit
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH -d, --datadir, --data-dir PATH
Path to the base directory of the exchange with Path to the base directory of the exchange with
historical backtesting data. To see futures data, use historical backtesting data. To see futures data, use
trading-mode additionally. trading-mode additionally.
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
``` ```
docs/commands/create-userdir.md
+1 -1
View File
@@ -3,7 +3,7 @@ usage: freqtrade create-userdir [-h] [--userdir PATH] [--reset]
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
--reset Reset sample files to their original state. --reset Reset sample files to their original state.
docs/commands/download-data.md
+7 -8
View File
@@ -15,7 +15,7 @@ usage: freqtrade download-data [-h] [-v] [--no-color] [--logfile FILE] [-V]
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
-p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...] -p, --pairs PAIRS [PAIRS ...]
Limit command to these pairs. Pairs are space- Limit command to these pairs. Pairs are space-
separated. separated.
--pairs-file FILE File containing a list of pairs. Takes precedence over --pairs-file FILE File containing a list of pairs. Takes precedence over
@@ -37,7 +37,7 @@ options:
OHLCV (e.g. Kraken). If not provided, use `trades-to- OHLCV (e.g. Kraken). If not provided, use `trades-to-
ohlcv` to convert trades data to OHLCV data. ohlcv` to convert trades data to OHLCV data.
--exchange EXCHANGE Exchange name. Only valid if no config is provided. --exchange EXCHANGE Exchange name. Only valid if no config is provided.
-t TIMEFRAMES [TIMEFRAMES ...], --timeframes TIMEFRAMES [TIMEFRAMES ...] -t, --timeframes TIMEFRAMES [TIMEFRAMES ...]
Specify which tickers to download. Space-separated Specify which tickers to download. Space-separated
list. Default: `1m 5m`. list. Default: `1m 5m`.
--erase Clean all existing data for the selected --erase Clean all existing data for the selected
@@ -48,7 +48,7 @@ options:
--data-format-trades {json,jsongz,feather,parquet} --data-format-trades {json,jsongz,feather,parquet}
Storage format for downloaded trades data. (default: Storage format for downloaded trades data. (default:
`feather`). `feather`).
--trading-mode {spot,margin,futures}, --tradingmode {spot,margin,futures} --trading-mode, --tradingmode {spot,margin,futures}
Select Trading mode Select Trading mode
--prepend Allow data prepending. (Data-appending is disabled) --prepend Allow data prepending. (Data-appending is disabled)
@@ -56,21 +56,20 @@ Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file. useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more 'syslog', 'journald'. See the documentation for more
details. details.
-V, --version show program's version number and exit -V, --version show program's version number and exit
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH -d, --datadir, --data-dir PATH
Path to the base directory of the exchange with Path to the base directory of the exchange with
historical backtesting data. To see futures data, use historical backtesting data. To see futures data, use
trading-mode additionally. trading-mode additionally.
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
``` ```
docs/commands/edge.md
+7 -9
View File
@@ -10,7 +10,7 @@ usage: freqtrade edge [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH]
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
-i TIMEFRAME, --timeframe TIMEFRAME -i, --timeframe TIMEFRAME
Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`). Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`).
--timerange TIMERANGE --timerange TIMERANGE
Specify what timerange of data to use. Specify what timerange of data to use.
@@ -25,7 +25,7 @@ options:
setting. setting.
--fee FLOAT Specify fee ratio. Will be applied twice (on trade --fee FLOAT Specify fee ratio. Will be applied twice (on trade
entry and exit). entry and exit).
-p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...] -p, --pairs PAIRS [PAIRS ...]
Limit command to these pairs. Pairs are space- Limit command to these pairs. Pairs are space-
separated. separated.
@@ -33,26 +33,24 @@ Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file. useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more 'syslog', 'journald'. See the documentation for more
details. details.
-V, --version show program's version number and exit -V, --version show program's version number and exit
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH -d, --datadir, --data-dir PATH
Path to the base directory of the exchange with Path to the base directory of the exchange with
historical backtesting data. To see futures data, use historical backtesting data. To see futures data, use
trading-mode additionally. trading-mode additionally.
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
Strategy arguments: Strategy arguments:
-s NAME, --strategy NAME -s, --strategy NAME Specify strategy class name which will be used by the
Specify strategy class name which will be used by the
bot. bot.
--strategy-path PATH Specify additional strategy lookup path. --strategy-path PATH Specify additional strategy lookup path.
--recursive-strategy-search --recursive-strategy-search
docs/commands/hyperopt-list.md
+4 -5
View File
@@ -44,21 +44,20 @@ Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file. useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more 'syslog', 'journald'. See the documentation for more
details. details.
-V, --version show program's version number and exit -V, --version show program's version number and exit
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH -d, --datadir, --data-dir PATH
Path to the base directory of the exchange with Path to the base directory of the exchange with
historical backtesting data. To see futures data, use historical backtesting data. To see futures data, use
trading-mode additionally. trading-mode additionally.
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
``` ```
docs/commands/hyperopt-show.md
+5 -6
View File
@@ -10,7 +10,7 @@ options:
-h, --help show this help message and exit -h, --help show this help message and exit
--best Select only best epochs. --best Select only best epochs.
--profitable Select only profitable epochs. --profitable Select only profitable epochs.
-n INT, --index INT Specify the index of the epoch to print details for. -n, --index INT Specify the index of the epoch to print details for.
--print-json Print output in JSON format. --print-json Print output in JSON format.
--hyperopt-filename FILENAME --hyperopt-filename FILENAME
Hyperopt result filename.Example: `--hyperopt- Hyperopt result filename.Example: `--hyperopt-
@@ -26,21 +26,20 @@ Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file. useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more 'syslog', 'journald'. See the documentation for more
details. details.
-V, --version show program's version number and exit -V, --version show program's version number and exit
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH -d, --datadir, --data-dir PATH
Path to the base directory of the exchange with Path to the base directory of the exchange with
historical backtesting data. To see futures data, use historical backtesting data. To see futures data, use
trading-mode additionally. trading-mode additionally.
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
``` ```
docs/commands/hyperopt.md
+11 -13
View File
@@ -19,7 +19,7 @@ usage: freqtrade hyperopt [-h] [-v] [--no-color] [--logfile FILE] [-V]
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
-i TIMEFRAME, --timeframe TIMEFRAME -i, --timeframe TIMEFRAME
Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`). Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`).
--timerange TIMERANGE --timerange TIMERANGE
Specify what timerange of data to use. Specify what timerange of data to use.
@@ -34,7 +34,7 @@ options:
setting. setting.
--fee FLOAT Specify fee ratio. Will be applied twice (on trade --fee FLOAT Specify fee ratio. Will be applied twice (on trade
entry and exit). entry and exit).
-p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...] -p, --pairs PAIRS [PAIRS ...]
Limit command to these pairs. Pairs are space- Limit command to these pairs. Pairs are space-
separated. separated.
--hyperopt-path PATH Specify additional lookup path for Hyperopt Loss --hyperopt-path PATH Specify additional lookup path for Hyperopt Loss
@@ -46,13 +46,13 @@ options:
Enable protections for backtesting. Will slow Enable protections for backtesting. Will slow
backtesting down by a considerable amount, but will backtesting down by a considerable amount, but will
include configured protections include configured protections
--dry-run-wallet DRY_RUN_WALLET, --starting-balance DRY_RUN_WALLET --dry-run-wallet, --starting-balance DRY_RUN_WALLET
Starting balance, used for backtesting / hyperopt and Starting balance, used for backtesting / hyperopt and
dry-runs. dry-runs.
--timeframe-detail TIMEFRAME_DETAIL --timeframe-detail TIMEFRAME_DETAIL
Specify detail timeframe for backtesting (`1m`, `5m`, Specify detail timeframe for backtesting (`1m`, `5m`,
`30m`, `1h`, `1d`). `30m`, `1h`, `1d`).
-e INT, --epochs INT Specify number of epochs (default: 100). -e, --epochs INT Specify number of epochs (default: 100).
--spaces SPACES [SPACES ...] --spaces SPACES [SPACES ...]
Specify which parameters to hyperopt. Space-separated Specify which parameters to hyperopt. Space-separated
list. Available builtin options (custom spaces will list. Available builtin options (custom spaces will
@@ -62,7 +62,7 @@ options:
for 'trailing', 'protection', and 'trades'. for 'trailing', 'protection', and 'trades'.
--print-all Print all results, not only the best ones. --print-all Print all results, not only the best ones.
--print-json Print output in JSON format. --print-json Print output in JSON format.
-j JOBS, --job-workers JOBS -j, --job-workers JOBS
The number of concurrently running jobs for The number of concurrently running jobs for
hyperoptimization (hyperopt worker processes). If -1 hyperoptimization (hyperopt worker processes). If -1
(default), all CPUs are used, for -2, all CPUs but one (default), all CPUs are used, for -2, all CPUs but one
@@ -72,7 +72,7 @@ options:
reproducible hyperopt results. reproducible hyperopt results.
--min-trades INT Set minimal desired number of trades for evaluations --min-trades INT Set minimal desired number of trades for evaluations
in the hyperopt optimization path (default: 1). in the hyperopt optimization path (default: 1).
--hyperopt-loss NAME, --hyperoptloss NAME --hyperopt-loss, --hyperoptloss NAME
Specify the class name of the hyperopt loss function Specify the class name of the hyperopt loss function
class (IHyperOptLoss). Different functions can class (IHyperOptLoss). Different functions can
generate completely different results, since the generate completely different results, since the
@@ -98,26 +98,24 @@ Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file. useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more 'syslog', 'journald'. See the documentation for more
details. details.
-V, --version show program's version number and exit -V, --version show program's version number and exit
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH -d, --datadir, --data-dir PATH
Path to the base directory of the exchange with Path to the base directory of the exchange with
historical backtesting data. To see futures data, use historical backtesting data. To see futures data, use
trading-mode additionally. trading-mode additionally.
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
Strategy arguments: Strategy arguments:
-s NAME, --strategy NAME -s, --strategy NAME Specify strategy class name which will be used by the
Specify strategy class name which will be used by the
bot. bot.
--strategy-path PATH Specify additional strategy lookup path. --strategy-path PATH Specify additional strategy lookup path.
--recursive-strategy-search --recursive-strategy-search
docs/commands/list-data.md
+6 -7
View File
@@ -18,10 +18,10 @@ options:
Storage format for downloaded trades data. (default: Storage format for downloaded trades data. (default:
`feather`). `feather`).
--trades Work on trades data instead of OHLCV data. --trades Work on trades data instead of OHLCV data.
-p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...] -p, --pairs PAIRS [PAIRS ...]
Limit command to these pairs. Pairs are space- Limit command to these pairs. Pairs are space-
separated. separated.
--trading-mode {spot,margin,futures}, --tradingmode {spot,margin,futures} --trading-mode, --tradingmode {spot,margin,futures}
Select Trading mode Select Trading mode
--show-timerange Show timerange available for available data. (May take --show-timerange Show timerange available for available data. (May take
a while to calculate). a while to calculate).
@@ -30,21 +30,20 @@ Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file. useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more 'syslog', 'journald'. See the documentation for more
details. details.
-V, --version show program's version number and exit -V, --version show program's version number and exit
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH -d, --datadir, --data-dir PATH
Path to the base directory of the exchange with Path to the base directory of the exchange with
historical backtesting data. To see futures data, use historical backtesting data. To see futures data, use
trading-mode additionally. trading-mode additionally.
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
``` ```
docs/commands/list-exchanges.md
+5 -6
View File
@@ -8,7 +8,7 @@ options:
-h, --help show this help message and exit -h, --help show this help message and exit
-1, --one-column Print output in one column. -1, --one-column Print output in one column.
-a, --all Print all exchanges known to the ccxt library. -a, --all Print all exchanges known to the ccxt library.
--trading-mode {spot,margin,futures}, --tradingmode {spot,margin,futures} --trading-mode, --tradingmode {spot,margin,futures}
Select Trading mode Select Trading mode
--dex-exchanges Print only DEX exchanges. --dex-exchanges Print only DEX exchanges.
@@ -16,21 +16,20 @@ Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file. useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more 'syslog', 'journald'. See the documentation for more
details. details.
-V, --version show program's version number and exit -V, --version show program's version number and exit
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH -d, --datadir, --data-dir PATH
Path to the base directory of the exchange with Path to the base directory of the exchange with
historical backtesting data. To see futures data, use historical backtesting data. To see futures data, use
trading-mode additionally. trading-mode additionally.
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
``` ```
docs/commands/list-freqaimodels.md
+4 -5
View File
@@ -13,21 +13,20 @@ Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file. useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more 'syslog', 'journald'. See the documentation for more
details. details.
-V, --version show program's version number and exit -V, --version show program's version number and exit
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH -d, --datadir, --data-dir PATH
Path to the base directory of the exchange with Path to the base directory of the exchange with
historical backtesting data. To see futures data, use historical backtesting data. To see futures data, use
trading-mode additionally. trading-mode additionally.
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
``` ```
docs/commands/list-hyperoptloss.md
+4 -5
View File
@@ -13,21 +13,20 @@ Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file. useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more 'syslog', 'journald'. See the documentation for more
details. details.
-V, --version show program's version number and exit -V, --version show program's version number and exit
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH -d, --datadir, --data-dir PATH
Path to the base directory of the exchange with Path to the base directory of the exchange with
historical backtesting data. To see futures data, use historical backtesting data. To see futures data, use
trading-mode additionally. trading-mode additionally.
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
``` ```
docs/commands/list-markets.md
+5 -6
View File
@@ -21,28 +21,27 @@ options:
Specify quote currency(-ies). Space-separated list. Specify quote currency(-ies). Space-separated list.
-a, --all Print all pairs or market symbols. By default only -a, --all Print all pairs or market symbols. By default only
active ones are shown. active ones are shown.
--trading-mode {spot,margin,futures}, --tradingmode {spot,margin,futures} --trading-mode, --tradingmode {spot,margin,futures}
Select Trading mode Select Trading mode
Common arguments: Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file. useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more 'syslog', 'journald'. See the documentation for more
details. details.
-V, --version show program's version number and exit -V, --version show program's version number and exit
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH -d, --datadir, --data-dir PATH
Path to the base directory of the exchange with Path to the base directory of the exchange with
historical backtesting data. To see futures data, use historical backtesting data. To see futures data, use
trading-mode additionally. trading-mode additionally.
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
``` ```
docs/commands/list-pairs.md
+5 -6
View File
@@ -21,28 +21,27 @@ options:
Specify quote currency(-ies). Space-separated list. Specify quote currency(-ies). Space-separated list.
-a, --all Print all pairs or market symbols. By default only -a, --all Print all pairs or market symbols. By default only
active ones are shown. active ones are shown.
--trading-mode {spot,margin,futures}, --tradingmode {spot,margin,futures} --trading-mode, --tradingmode {spot,margin,futures}
Select Trading mode Select Trading mode
Common arguments: Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file. useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more 'syslog', 'journald'. See the documentation for more
details. details.
-V, --version show program's version number and exit -V, --version show program's version number and exit
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH -d, --datadir, --data-dir PATH
Path to the base directory of the exchange with Path to the base directory of the exchange with
historical backtesting data. To see futures data, use historical backtesting data. To see futures data, use
trading-mode additionally. trading-mode additionally.
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
``` ```
docs/commands/list-strategies.md
+4 -5
View File
@@ -16,21 +16,20 @@ Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file. useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more 'syslog', 'journald'. See the documentation for more
details. details.
-V, --version show program's version number and exit -V, --version show program's version number and exit
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH -d, --datadir, --data-dir PATH
Path to the base directory of the exchange with Path to the base directory of the exchange with
historical backtesting data. To see futures data, use historical backtesting data. To see futures data, use
trading-mode additionally. trading-mode additionally.
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
``` ```
docs/commands/list-timeframes.md
+4 -5
View File
@@ -12,21 +12,20 @@ Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file. useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more 'syslog', 'journald'. See the documentation for more
details. details.
-V, --version show program's version number and exit -V, --version show program's version number and exit
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH -d, --datadir, --data-dir PATH
Path to the base directory of the exchange with Path to the base directory of the exchange with
historical backtesting data. To see futures data, use historical backtesting data. To see futures data, use
trading-mode additionally. trading-mode additionally.
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
``` ```
docs/commands/lookahead-analysis.md
+10 -12
View File
@@ -26,7 +26,7 @@ usage: freqtrade lookahead-analysis [-h] [-v] [--no-color] [--logfile FILE]
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
-i TIMEFRAME, --timeframe TIMEFRAME -i, --timeframe TIMEFRAME
Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`). Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`).
--timerange TIMERANGE --timerange TIMERANGE
Specify what timerange of data to use. Specify what timerange of data to use.
@@ -41,7 +41,7 @@ options:
setting. setting.
--fee FLOAT Specify fee ratio. Will be applied twice (on trade --fee FLOAT Specify fee ratio. Will be applied twice (on trade
entry and exit). entry and exit).
-p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...] -p, --pairs PAIRS [PAIRS ...]
Limit command to these pairs. Pairs are space- Limit command to these pairs. Pairs are space-
separated. separated.
--enable-protections, --enableprotections --enable-protections, --enableprotections
@@ -53,7 +53,7 @@ options:
pairlist will be generated for each new candle if pairlist will be generated for each new candle if
you're using a pairlist handler that supports this you're using a pairlist handler that supports this
feature, for example, ShuffleFilter. feature, for example, ShuffleFilter.
--dry-run-wallet DRY_RUN_WALLET, --starting-balance DRY_RUN_WALLET --dry-run-wallet, --starting-balance DRY_RUN_WALLET
Starting balance, used for backtesting / hyperopt and Starting balance, used for backtesting / hyperopt and
dry-runs. dry-runs.
--timeframe-detail TIMEFRAME_DETAIL --timeframe-detail TIMEFRAME_DETAIL
@@ -68,13 +68,13 @@ options:
becomes `backtest-data-SampleStrategy.json` becomes `backtest-data-SampleStrategy.json`
--export {none,trades,signals} --export {none,trades,signals}
Export backtest results (default: trades). Export backtest results (default: trades).
--backtest-filename PATH, --export-filename PATH --backtest-filename, --export-filename PATH
Use this filename for backtest results.Example: Use this filename for backtest results.Example:
`--backtest- `--backtest-
filename=backtest_results_2020-09-27_16-20-48.json`. filename=backtest_results_2020-09-27_16-20-48.json`.
Assumes either `user_data/backtest_results/` or Assumes either `user_data/backtest_results/` or
`--export-directory` as base directory. `--export-directory` as base directory.
--backtest-directory PATH, --export-directory PATH --backtest-directory, --export-directory PATH
Directory to use for backtest results. Example: Directory to use for backtest results. Example:
`--export-directory=user_data/backtest_results/`. `--export-directory=user_data/backtest_results/`.
--freqai-backtest-live-models --freqai-backtest-live-models
@@ -93,26 +93,24 @@ Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file. useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more 'syslog', 'journald'. See the documentation for more
details. details.
-V, --version show program's version number and exit -V, --version show program's version number and exit
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH -d, --datadir, --data-dir PATH
Path to the base directory of the exchange with Path to the base directory of the exchange with
historical backtesting data. To see futures data, use historical backtesting data. To see futures data, use
trading-mode additionally. trading-mode additionally.
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
Strategy arguments: Strategy arguments:
-s NAME, --strategy NAME -s, --strategy NAME Specify strategy class name which will be used by the
Specify strategy class name which will be used by the
bot. bot.
--strategy-path PATH Specify additional strategy lookup path. --strategy-path PATH Specify additional strategy lookup path.
--recursive-strategy-search --recursive-strategy-search
docs/commands/main.md
+1 -2
View File
@@ -1,7 +1,6 @@
``` ```
usage: freqtrade [-h] [-V] usage: freqtrade [-h] [-V]
{trade,create-userdir,new-config,show-config,new-strategy,download-data,convert-data,convert-trade-data,trades-to-ohlcv,list-data,backtesting,backtesting-show,backtesting-analysis,edge,hyperopt,hyperopt-list,hyperopt-show,list-exchanges,list-markets,list-pairs,list-strategies,list-hyperoptloss,list-freqaimodels,list-timeframes,show-trades,test-pairlist,convert-db,install-ui,plot-dataframe,plot-profit,webserver,strategy-updater,lookahead-analysis,recursive-analysis} {trade,create-userdir,new-config,show-config,new-strategy,download-data,convert-data,convert-trade-data,trades-to-ohlcv,list-data,backtesting,backtesting-show,backtesting-analysis,edge,hyperopt,hyperopt-list,hyperopt-show,list-exchanges,list-markets,list-pairs,list-strategies,list-hyperoptloss,list-freqaimodels,list-timeframes,show-trades,test-pairlist,convert-db,install-ui,plot-dataframe,plot-profit,webserver,strategy-updater,lookahead-analysis,recursive-analysis} ...
...
Free, open source crypto trading bot Free, open source crypto trading bot
docs/commands/new-config.md
+5 -6
View File
@@ -2,11 +2,10 @@
usage: freqtrade new-config [-h] [-c PATH] usage: freqtrade new-config [-h] [-c PATH]
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default: `userdir/config.json` or `config.json` whichever exists).
`userdir/config.json` or `config.json` whichever Multiple --config options may be used. Can be set to `-`
exists). Multiple --config options may be used. Can be to read config from stdin.
set to `-` to read config from stdin.
``` ```
docs/commands/new-strategy.md
+2 -3
View File
@@ -5,10 +5,9 @@ usage: freqtrade new-strategy [-h] [--userdir PATH] [-s NAME]
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
-s NAME, --strategy NAME -s, --strategy NAME Specify strategy class name which will be used by the
Specify strategy class name which will be used by the
bot. bot.
--strategy-path PATH Specify additional strategy lookup path. --strategy-path PATH Specify additional strategy lookup path.
--template {full,minimal,advanced} --template {full,minimal,advanced}
docs/commands/plot-dataframe.md
+8 -10
View File
@@ -16,7 +16,7 @@ usage: freqtrade plot-dataframe [-h] [-v] [--no-color] [--logfile FILE] [-V]
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
-p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...] -p, --pairs PAIRS [PAIRS ...]
Limit command to these pairs. Pairs are space- Limit command to these pairs. Pairs are space-
separated. separated.
--indicators1 INDICATORS1 [INDICATORS1 ...] --indicators1 INDICATORS1 [INDICATORS1 ...]
@@ -38,7 +38,7 @@ options:
(backtest file)) Default: file (backtest file)) Default: file
--export {none,trades,signals} --export {none,trades,signals}
Export backtest results (default: trades). Export backtest results (default: trades).
--backtest-filename PATH, --export-filename PATH --backtest-filename, --export-filename PATH
Use this filename for backtest results.Example: Use this filename for backtest results.Example:
`--backtest- `--backtest-
filename=backtest_results_2020-09-27_16-20-48.json`. filename=backtest_results_2020-09-27_16-20-48.json`.
@@ -46,7 +46,7 @@ options:
`--export-directory` as base directory. `--export-directory` as base directory.
--timerange TIMERANGE --timerange TIMERANGE
Specify what timerange of data to use. Specify what timerange of data to use.
-i TIMEFRAME, --timeframe TIMEFRAME -i, --timeframe TIMEFRAME
Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`). Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`).
--no-trades Skip using trades from backtesting file and DB. --no-trades Skip using trades from backtesting file and DB.
@@ -54,26 +54,24 @@ Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file. useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more 'syslog', 'journald'. See the documentation for more
details. details.
-V, --version show program's version number and exit -V, --version show program's version number and exit
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH -d, --datadir, --data-dir PATH
Path to the base directory of the exchange with Path to the base directory of the exchange with
historical backtesting data. To see futures data, use historical backtesting data. To see futures data, use
trading-mode additionally. trading-mode additionally.
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
Strategy arguments: Strategy arguments:
-s NAME, --strategy NAME -s, --strategy NAME Specify strategy class name which will be used by the
Specify strategy class name which will be used by the
bot. bot.
--strategy-path PATH Specify additional strategy lookup path. --strategy-path PATH Specify additional strategy lookup path.
--recursive-strategy-search --recursive-strategy-search
docs/commands/plot-profit.md
+8 -10
View File
@@ -12,14 +12,14 @@ usage: freqtrade plot-profit [-h] [-v] [--no-color] [--logfile FILE] [-V]
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
-p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...] -p, --pairs PAIRS [PAIRS ...]
Limit command to these pairs. Pairs are space- Limit command to these pairs. Pairs are space-
separated. separated.
--timerange TIMERANGE --timerange TIMERANGE
Specify what timerange of data to use. Specify what timerange of data to use.
--export {none,trades,signals} --export {none,trades,signals}
Export backtest results (default: trades). Export backtest results (default: trades).
--backtest-filename PATH, --export-filename PATH --backtest-filename, --export-filename PATH
Use this filename for backtest results.Example: Use this filename for backtest results.Example:
`--backtest- `--backtest-
filename=backtest_results_2020-09-27_16-20-48.json`. filename=backtest_results_2020-09-27_16-20-48.json`.
@@ -32,7 +32,7 @@ options:
--trade-source {DB,file} --trade-source {DB,file}
Specify the source for trades (Can be DB or file Specify the source for trades (Can be DB or file
(backtest file)) Default: file (backtest file)) Default: file
-i TIMEFRAME, --timeframe TIMEFRAME -i, --timeframe TIMEFRAME
Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`). Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`).
--auto-open Automatically open generated plot. --auto-open Automatically open generated plot.
@@ -40,26 +40,24 @@ Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file. useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more 'syslog', 'journald'. See the documentation for more
details. details.
-V, --version show program's version number and exit -V, --version show program's version number and exit
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH -d, --datadir, --data-dir PATH
Path to the base directory of the exchange with Path to the base directory of the exchange with
historical backtesting data. To see futures data, use historical backtesting data. To see futures data, use
trading-mode additionally. trading-mode additionally.
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
Strategy arguments: Strategy arguments:
-s NAME, --strategy NAME -s, --strategy NAME Specify strategy class name which will be used by the
Specify strategy class name which will be used by the
bot. bot.
--strategy-path PATH Specify additional strategy lookup path. --strategy-path PATH Specify additional strategy lookup path.
--recursive-strategy-search --recursive-strategy-search
docs/commands/recursive-analysis.md
+7 -9
View File
@@ -12,14 +12,14 @@ usage: freqtrade recursive-analysis [-h] [-v] [--no-color] [--logfile FILE]
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
-i TIMEFRAME, --timeframe TIMEFRAME -i, --timeframe TIMEFRAME
Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`). Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`).
--timerange TIMERANGE --timerange TIMERANGE
Specify what timerange of data to use. Specify what timerange of data to use.
--data-format-ohlcv {json,jsongz,feather,parquet} --data-format-ohlcv {json,jsongz,feather,parquet}
Storage format for downloaded candle (OHLCV) data. Storage format for downloaded candle (OHLCV) data.
(default: `feather`). (default: `feather`).
-p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...] -p, --pairs PAIRS [PAIRS ...]
Limit command to these pairs. Pairs are space- Limit command to these pairs. Pairs are space-
separated. separated.
--startup-candle STARTUP_CANDLE [STARTUP_CANDLE ...] --startup-candle STARTUP_CANDLE [STARTUP_CANDLE ...]
@@ -30,26 +30,24 @@ Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file. useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more 'syslog', 'journald'. See the documentation for more
details. details.
-V, --version show program's version number and exit -V, --version show program's version number and exit
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH -d, --datadir, --data-dir PATH
Path to the base directory of the exchange with Path to the base directory of the exchange with
historical backtesting data. To see futures data, use historical backtesting data. To see futures data, use
trading-mode additionally. trading-mode additionally.
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
Strategy arguments: Strategy arguments:
-s NAME, --strategy NAME -s, --strategy NAME Specify strategy class name which will be used by the
Specify strategy class name which will be used by the
bot. bot.
--strategy-path PATH Specify additional strategy lookup path. --strategy-path PATH Specify additional strategy lookup path.
--recursive-strategy-search --recursive-strategy-search
docs/commands/show-config.md
+2 -3
View File
@@ -4,10 +4,9 @@ usage: freqtrade show-config [-h] [--userdir PATH] [-c PATH]
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
docs/commands/show-trades.md
+4 -5
View File
@@ -19,21 +19,20 @@ Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file. useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more 'syslog', 'journald'. See the documentation for more
details. details.
-V, --version show program's version number and exit -V, --version show program's version number and exit
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH -d, --datadir, --data-dir PATH
Path to the base directory of the exchange with Path to the base directory of the exchange with
historical backtesting data. To see futures data, use historical backtesting data. To see futures data, use
trading-mode additionally. trading-mode additionally.
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
``` ```
docs/commands/strategy-updater.md
+4 -5
View File
@@ -23,21 +23,20 @@ Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file. useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more 'syslog', 'journald'. See the documentation for more
details. details.
-V, --version show program's version number and exit -V, --version show program's version number and exit
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH -d, --datadir, --data-dir PATH
Path to the base directory of the exchange with Path to the base directory of the exchange with
historical backtesting data. To see futures data, use historical backtesting data. To see futures data, use
trading-mode additionally. trading-mode additionally.
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
``` ```
docs/commands/test-pairlist.md
+2 -3
View File
@@ -5,11 +5,10 @@ usage: freqtrade test-pairlist [-h] [--userdir PATH] [-v] [-c PATH]
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
docs/commands/trade.md
+6 -8
View File
@@ -15,7 +15,7 @@ options:
--sd-notify Notify systemd service manager. --sd-notify Notify systemd service manager.
--dry-run Enforce dry-run for trading (removes Exchange secrets --dry-run Enforce dry-run for trading (removes Exchange secrets
and simulates trades). and simulates trades).
--dry-run-wallet DRY_RUN_WALLET, --starting-balance DRY_RUN_WALLET --dry-run-wallet, --starting-balance DRY_RUN_WALLET
Starting balance, used for backtesting / hyperopt and Starting balance, used for backtesting / hyperopt and
dry-runs. dry-runs.
--fee FLOAT Specify fee ratio. Will be applied twice (on trade --fee FLOAT Specify fee ratio. Will be applied twice (on trade
@@ -25,26 +25,24 @@ Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file. useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more 'syslog', 'journald'. See the documentation for more
details. details.
-V, --version show program's version number and exit -V, --version show program's version number and exit
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH -d, --datadir, --data-dir PATH
Path to the base directory of the exchange with Path to the base directory of the exchange with
historical backtesting data. To see futures data, use historical backtesting data. To see futures data, use
trading-mode additionally. trading-mode additionally.
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
Strategy arguments: Strategy arguments:
-s NAME, --strategy NAME -s, --strategy NAME Specify strategy class name which will be used by the
Specify strategy class name which will be used by the
bot. bot.
--strategy-path PATH Specify additional strategy lookup path. --strategy-path PATH Specify additional strategy lookup path.
--recursive-strategy-search --recursive-strategy-search
docs/commands/trades-to-ohlcv.md
+7 -8
View File
@@ -10,10 +10,10 @@ usage: freqtrade trades-to-ohlcv [-h] [-v] [--no-color] [--logfile FILE] [-V]
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
-p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...] -p, --pairs PAIRS [PAIRS ...]
Limit command to these pairs. Pairs are space- Limit command to these pairs. Pairs are space-
separated. separated.
-t TIMEFRAMES [TIMEFRAMES ...], --timeframes TIMEFRAMES [TIMEFRAMES ...] -t, --timeframes TIMEFRAMES [TIMEFRAMES ...]
Specify which tickers to download. Space-separated Specify which tickers to download. Space-separated
list. Default: `1m 5m`. list. Default: `1m 5m`.
--exchange EXCHANGE Exchange name. Only valid if no config is provided. --exchange EXCHANGE Exchange name. Only valid if no config is provided.
@@ -23,28 +23,27 @@ options:
--data-format-trades {json,jsongz,feather,parquet} --data-format-trades {json,jsongz,feather,parquet}
Storage format for downloaded trades data. (default: Storage format for downloaded trades data. (default:
`feather`). `feather`).
--trading-mode {spot,margin,futures}, --tradingmode {spot,margin,futures} --trading-mode, --tradingmode {spot,margin,futures}
Select Trading mode Select Trading mode
Common arguments: Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file. useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more 'syslog', 'journald'. See the documentation for more
details. details.
-V, --version show program's version number and exit -V, --version show program's version number and exit
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH -d, --datadir, --data-dir PATH
Path to the base directory of the exchange with Path to the base directory of the exchange with
historical backtesting data. To see futures data, use historical backtesting data. To see futures data, use
trading-mode additionally. trading-mode additionally.
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
``` ```
docs/commands/webserver.md
+4 -5
View File
@@ -9,21 +9,20 @@ Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages). -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--no-color Disable colorization of hyperopt results. May be --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file. useful if you are redirecting output to a file.
--logfile FILE, --log-file FILE --logfile, --log-file FILE
Log to the file specified. Special values are: Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more 'syslog', 'journald'. See the documentation for more
details. details.
-V, --version show program's version number and exit -V, --version show program's version number and exit
-c PATH, --config PATH -c, --config PATH Specify configuration file (default:
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever `userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin. set to `-` to read config from stdin.
-d PATH, --datadir PATH, --data-dir PATH -d, --datadir, --data-dir PATH
Path to the base directory of the exchange with Path to the base directory of the exchange with
historical backtesting data. To see futures data, use historical backtesting data. To see futures data, use
trading-mode additionally. trading-mode additionally.
--userdir PATH, --user-data-dir PATH --userdir, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
``` ```