diff --git a/docs/commands/backtesting-analysis.md b/docs/commands/backtesting-analysis.md index 826792f4f..d77979432 100644 --- a/docs/commands/backtesting-analysis.md +++ b/docs/commands/backtesting-analysis.md @@ -15,13 +15,13 @@ usage: freqtrade backtesting-analysis [-h] [-v] [--no-color] [--logfile FILE] options: -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: `--backtest- filename=backtest_results_2020-09-27_16-20-48.json`. Assumes either `user_data/backtest_results/` or `--export-directory` as base directory. - --backtest-directory PATH, --export-directory PATH + --backtest-directory, --export-directory PATH Directory to use for backtest results. Example: `--export-directory=user_data/backtest_results/`. --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). --no-color Disable colorization of hyperopt results. May be 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: '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: + -c, --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 + -d, --datadir, --data-dir PATH Path to the base directory of the exchange with historical backtesting data. To see futures data, use trading-mode additionally. - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. ``` diff --git a/docs/commands/backtesting-show.md b/docs/commands/backtesting-show.md index 31d1d44fd..3574f4dd5 100644 --- a/docs/commands/backtesting-show.md +++ b/docs/commands/backtesting-show.md @@ -8,13 +8,13 @@ usage: freqtrade backtesting-show [-h] [-v] [--no-color] [--logfile FILE] [-V] options: -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: `--backtest- filename=backtest_results_2020-09-27_16-20-48.json`. Assumes either `user_data/backtest_results/` or `--export-directory` as base directory. - --backtest-directory PATH, --export-directory PATH + --backtest-directory, --export-directory PATH Directory to use for backtest results. Example: `--export-directory=user_data/backtest_results/`. --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). --no-color Disable colorization of hyperopt results. May be 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: '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: + -c, --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 + -d, --datadir, --data-dir PATH Path to the base directory of the exchange with historical backtesting data. To see futures data, use trading-mode additionally. - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. ``` diff --git a/docs/commands/backtesting.md b/docs/commands/backtesting.md index 2383c3614..3554bb8d8 100644 --- a/docs/commands/backtesting.md +++ b/docs/commands/backtesting.md @@ -23,7 +23,7 @@ usage: freqtrade backtesting [-h] [-v] [--no-color] [--logfile FILE] [-V] options: -h, --help show this help message and exit - -i TIMEFRAME, --timeframe TIMEFRAME + -i, --timeframe TIMEFRAME Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`). --timerange TIMERANGE Specify what timerange of data to use. @@ -38,7 +38,7 @@ options: setting. --fee FLOAT Specify fee ratio. Will be applied twice (on trade entry and exit). - -p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...] + -p, --pairs PAIRS [PAIRS ...] Limit command to these pairs. Pairs are space- separated. --eps, --enable-position-stacking @@ -53,7 +53,7 @@ options: pairlist will be generated for each new candle if you're using a pairlist handler that supports this 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 dry-runs. --timeframe-detail TIMEFRAME_DETAIL @@ -68,13 +68,13 @@ options: becomes `backtest-data-SampleStrategy.json` --export {none,trades,signals} Export backtest results (default: trades). - --backtest-filename PATH, --export-filename PATH + --backtest-filename, --export-filename PATH Use this filename for backtest results.Example: `--backtest- filename=backtest_results_2020-09-27_16-20-48.json`. Assumes either `user_data/backtest_results/` or `--export-directory` as base directory. - --backtest-directory PATH, --export-directory PATH + --backtest-directory, --export-directory PATH Directory to use for backtest results. Example: `--export-directory=user_data/backtest_results/`. --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). --no-color Disable colorization of hyperopt results. May be 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: '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: + -c, --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 + -d, --datadir, --data-dir PATH Path to the base directory of the exchange with historical backtesting data. To see futures data, use trading-mode additionally. - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. Strategy arguments: - -s NAME, --strategy NAME - Specify strategy class name which will be used by the + -s, --strategy NAME Specify strategy class name which will be used by the bot. --strategy-path PATH Specify additional strategy lookup path. --recursive-strategy-search diff --git a/docs/commands/convert-data.md b/docs/commands/convert-data.md index 32996eba3..ea2c8f7ae 100644 --- a/docs/commands/convert-data.md +++ b/docs/commands/convert-data.md @@ -1,17 +1,17 @@ ``` usage: freqtrade convert-data [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] - [-p PAIRS [PAIRS ...]] --format-from - {json,jsongz,feather,parquet} --format-to - {json,jsongz,feather,parquet} [--erase] - [--exchange EXCHANGE] + [-p PAIRS [PAIRS ...]] + --format-from {json,jsongz,feather,parquet} + --format-to {json,jsongz,feather,parquet} + [--erase] [--exchange EXCHANGE] [-t TIMEFRAMES [TIMEFRAMES ...]] [--trading-mode {spot,margin,futures}] [--candle-types {spot,futures,mark,index,premiumIndex,funding_rate} [{spot,futures,mark,index,premiumIndex,funding_rate} ...]] options: -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- separated. --format-from {json,jsongz,feather,parquet} @@ -21,10 +21,10 @@ options: --erase Clean all existing data for the selected exchange/pairs/timeframes. --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 list. Default: `1m 5m`. - --trading-mode {spot,margin,futures}, --tradingmode {spot,margin,futures} + --trading-mode, --tradingmode {spot,margin,futures} Select Trading mode --candle-types {spot,futures,mark,index,premiumIndex,funding_rate} [{spot,futures,mark,index,premiumIndex,funding_rate} ...] 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). --no-color Disable colorization of hyperopt results. May be 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: '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: + -c, --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 + -d, --datadir, --data-dir PATH Path to the base directory of the exchange with historical backtesting data. To see futures data, use trading-mode additionally. - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. ``` diff --git a/docs/commands/convert-trade-data.md b/docs/commands/convert-trade-data.md index cf53e5329..7a28e1399 100644 --- a/docs/commands/convert-trade-data.md +++ b/docs/commands/convert-trade-data.md @@ -1,14 +1,14 @@ ``` usage: freqtrade convert-trade-data [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] - [-p PAIRS [PAIRS ...]] --format-from - {json,jsongz,feather,parquet,kraken_csv} + [-p PAIRS [PAIRS ...]] + --format-from {json,jsongz,feather,parquet,kraken_csv} --format-to {json,jsongz,feather,parquet} [--erase] [--exchange EXCHANGE] options: -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- separated. --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). --no-color Disable colorization of hyperopt results. May be 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: '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: + -c, --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 + -d, --datadir, --data-dir PATH Path to the base directory of the exchange with historical backtesting data. To see futures data, use trading-mode additionally. - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. ``` diff --git a/docs/commands/create-userdir.md b/docs/commands/create-userdir.md index 9d52e2cf4..6351ffcea 100644 --- a/docs/commands/create-userdir.md +++ b/docs/commands/create-userdir.md @@ -3,7 +3,7 @@ usage: freqtrade create-userdir [-h] [--userdir PATH] [--reset] options: -h, --help show this help message and exit - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. --reset Reset sample files to their original state. diff --git a/docs/commands/download-data.md b/docs/commands/download-data.md index 2975d0717..87ec88080 100644 --- a/docs/commands/download-data.md +++ b/docs/commands/download-data.md @@ -15,7 +15,7 @@ usage: freqtrade download-data [-h] [-v] [--no-color] [--logfile FILE] [-V] options: -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- separated. --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` to convert trades data to OHLCV data. --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 list. Default: `1m 5m`. --erase Clean all existing data for the selected @@ -48,7 +48,7 @@ options: --data-format-trades {json,jsongz,feather,parquet} Storage format for downloaded trades data. (default: `feather`). - --trading-mode {spot,margin,futures}, --tradingmode {spot,margin,futures} + --trading-mode, --tradingmode {spot,margin,futures} Select Trading mode --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). --no-color Disable colorization of hyperopt results. May be 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: '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: + -c, --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 + -d, --datadir, --data-dir PATH Path to the base directory of the exchange with historical backtesting data. To see futures data, use trading-mode additionally. - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. ``` diff --git a/docs/commands/edge.md b/docs/commands/edge.md index 9e5f95ed3..7851c8c24 100644 --- a/docs/commands/edge.md +++ b/docs/commands/edge.md @@ -10,7 +10,7 @@ usage: freqtrade edge [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] options: -h, --help show this help message and exit - -i TIMEFRAME, --timeframe TIMEFRAME + -i, --timeframe TIMEFRAME Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`). --timerange TIMERANGE Specify what timerange of data to use. @@ -25,7 +25,7 @@ options: setting. --fee FLOAT Specify fee ratio. Will be applied twice (on trade entry and exit). - -p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...] + -p, --pairs PAIRS [PAIRS ...] Limit command to these pairs. Pairs are space- separated. @@ -33,26 +33,24 @@ Common arguments: -v, --verbose Verbose mode (-vv for more, -vvv to get all messages). --no-color Disable colorization of hyperopt results. May be 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: '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: + -c, --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 + -d, --datadir, --data-dir PATH Path to the base directory of the exchange with historical backtesting data. To see futures data, use trading-mode additionally. - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. Strategy arguments: - -s NAME, --strategy NAME - Specify strategy class name which will be used by the + -s, --strategy NAME Specify strategy class name which will be used by the bot. --strategy-path PATH Specify additional strategy lookup path. --recursive-strategy-search diff --git a/docs/commands/hyperopt-list.md b/docs/commands/hyperopt-list.md index 8457aba27..a58caddea 100644 --- a/docs/commands/hyperopt-list.md +++ b/docs/commands/hyperopt-list.md @@ -44,21 +44,20 @@ Common arguments: -v, --verbose Verbose mode (-vv for more, -vvv to get all messages). --no-color Disable colorization of hyperopt results. May be 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: '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: + -c, --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 + -d, --datadir, --data-dir PATH Path to the base directory of the exchange with historical backtesting data. To see futures data, use trading-mode additionally. - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. ``` diff --git a/docs/commands/hyperopt-show.md b/docs/commands/hyperopt-show.md index 354a3afcf..d82f5283f 100644 --- a/docs/commands/hyperopt-show.md +++ b/docs/commands/hyperopt-show.md @@ -10,7 +10,7 @@ options: -h, --help show this help message and exit --best Select only best 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. --hyperopt-filename FILENAME Hyperopt result filename.Example: `--hyperopt- @@ -26,21 +26,20 @@ Common arguments: -v, --verbose Verbose mode (-vv for more, -vvv to get all messages). --no-color Disable colorization of hyperopt results. May be 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: '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: + -c, --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 + -d, --datadir, --data-dir PATH Path to the base directory of the exchange with historical backtesting data. To see futures data, use trading-mode additionally. - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. ``` diff --git a/docs/commands/hyperopt.md b/docs/commands/hyperopt.md index 4d9a75b22..b5032f4b9 100644 --- a/docs/commands/hyperopt.md +++ b/docs/commands/hyperopt.md @@ -19,7 +19,7 @@ usage: freqtrade hyperopt [-h] [-v] [--no-color] [--logfile FILE] [-V] options: -h, --help show this help message and exit - -i TIMEFRAME, --timeframe TIMEFRAME + -i, --timeframe TIMEFRAME Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`). --timerange TIMERANGE Specify what timerange of data to use. @@ -34,7 +34,7 @@ options: setting. --fee FLOAT Specify fee ratio. Will be applied twice (on trade entry and exit). - -p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...] + -p, --pairs PAIRS [PAIRS ...] Limit command to these pairs. Pairs are space- separated. --hyperopt-path PATH Specify additional lookup path for Hyperopt Loss @@ -46,13 +46,13 @@ options: Enable protections for backtesting. Will slow backtesting down by a considerable amount, but will 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 dry-runs. --timeframe-detail TIMEFRAME_DETAIL Specify detail timeframe for backtesting (`1m`, `5m`, `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 ...] Specify which parameters to hyperopt. Space-separated list. Available builtin options (custom spaces will @@ -62,7 +62,7 @@ options: for 'trailing', 'protection', and 'trades'. --print-all Print all results, not only the best ones. --print-json Print output in JSON format. - -j JOBS, --job-workers JOBS + -j, --job-workers JOBS The number of concurrently running jobs for hyperoptimization (hyperopt worker processes). If -1 (default), all CPUs are used, for -2, all CPUs but one @@ -72,7 +72,7 @@ options: reproducible hyperopt results. --min-trades INT Set minimal desired number of trades for evaluations 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 class (IHyperOptLoss). Different functions can generate completely different results, since the @@ -98,26 +98,24 @@ Common arguments: -v, --verbose Verbose mode (-vv for more, -vvv to get all messages). --no-color Disable colorization of hyperopt results. May be 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: '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: + -c, --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 + -d, --datadir, --data-dir PATH Path to the base directory of the exchange with historical backtesting data. To see futures data, use trading-mode additionally. - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. Strategy arguments: - -s NAME, --strategy NAME - Specify strategy class name which will be used by the + -s, --strategy NAME Specify strategy class name which will be used by the bot. --strategy-path PATH Specify additional strategy lookup path. --recursive-strategy-search diff --git a/docs/commands/list-data.md b/docs/commands/list-data.md index 515207178..f56febd28 100644 --- a/docs/commands/list-data.md +++ b/docs/commands/list-data.md @@ -18,10 +18,10 @@ options: Storage format for downloaded trades data. (default: `feather`). --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- separated. - --trading-mode {spot,margin,futures}, --tradingmode {spot,margin,futures} + --trading-mode, --tradingmode {spot,margin,futures} Select Trading mode --show-timerange Show timerange available for available data. (May take a while to calculate). @@ -30,21 +30,20 @@ Common arguments: -v, --verbose Verbose mode (-vv for more, -vvv to get all messages). --no-color Disable colorization of hyperopt results. May be 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: '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: + -c, --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 + -d, --datadir, --data-dir PATH Path to the base directory of the exchange with historical backtesting data. To see futures data, use trading-mode additionally. - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. ``` diff --git a/docs/commands/list-exchanges.md b/docs/commands/list-exchanges.md index a5a249cd9..41c45302a 100644 --- a/docs/commands/list-exchanges.md +++ b/docs/commands/list-exchanges.md @@ -8,7 +8,7 @@ options: -h, --help show this help message and exit -1, --one-column Print output in one column. -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 --dex-exchanges Print only DEX exchanges. @@ -16,21 +16,20 @@ Common arguments: -v, --verbose Verbose mode (-vv for more, -vvv to get all messages). --no-color Disable colorization of hyperopt results. May be 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: '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: + -c, --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 + -d, --datadir, --data-dir PATH Path to the base directory of the exchange with historical backtesting data. To see futures data, use trading-mode additionally. - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. ``` diff --git a/docs/commands/list-freqaimodels.md b/docs/commands/list-freqaimodels.md index c4a588eba..d82bc5ac0 100644 --- a/docs/commands/list-freqaimodels.md +++ b/docs/commands/list-freqaimodels.md @@ -13,21 +13,20 @@ Common arguments: -v, --verbose Verbose mode (-vv for more, -vvv to get all messages). --no-color Disable colorization of hyperopt results. May be 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: '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: + -c, --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 + -d, --datadir, --data-dir PATH Path to the base directory of the exchange with historical backtesting data. To see futures data, use trading-mode additionally. - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. ``` diff --git a/docs/commands/list-hyperoptloss.md b/docs/commands/list-hyperoptloss.md index 2762c3fe7..149eaf2f0 100644 --- a/docs/commands/list-hyperoptloss.md +++ b/docs/commands/list-hyperoptloss.md @@ -13,21 +13,20 @@ Common arguments: -v, --verbose Verbose mode (-vv for more, -vvv to get all messages). --no-color Disable colorization of hyperopt results. May be 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: '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: + -c, --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 + -d, --datadir, --data-dir PATH Path to the base directory of the exchange with historical backtesting data. To see futures data, use trading-mode additionally. - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. ``` diff --git a/docs/commands/list-markets.md b/docs/commands/list-markets.md index d2233e1da..d0d97c00c 100644 --- a/docs/commands/list-markets.md +++ b/docs/commands/list-markets.md @@ -21,28 +21,27 @@ options: Specify quote currency(-ies). Space-separated list. -a, --all Print all pairs or market symbols. By default only active ones are shown. - --trading-mode {spot,margin,futures}, --tradingmode {spot,margin,futures} + --trading-mode, --tradingmode {spot,margin,futures} Select Trading mode Common arguments: -v, --verbose Verbose mode (-vv for more, -vvv to get all messages). --no-color Disable colorization of hyperopt results. May be 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: '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: + -c, --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 + -d, --datadir, --data-dir PATH Path to the base directory of the exchange with historical backtesting data. To see futures data, use trading-mode additionally. - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. ``` diff --git a/docs/commands/list-pairs.md b/docs/commands/list-pairs.md index 3f991e414..e2e5a0085 100644 --- a/docs/commands/list-pairs.md +++ b/docs/commands/list-pairs.md @@ -21,28 +21,27 @@ options: Specify quote currency(-ies). Space-separated list. -a, --all Print all pairs or market symbols. By default only active ones are shown. - --trading-mode {spot,margin,futures}, --tradingmode {spot,margin,futures} + --trading-mode, --tradingmode {spot,margin,futures} Select Trading mode Common arguments: -v, --verbose Verbose mode (-vv for more, -vvv to get all messages). --no-color Disable colorization of hyperopt results. May be 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: '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: + -c, --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 + -d, --datadir, --data-dir PATH Path to the base directory of the exchange with historical backtesting data. To see futures data, use trading-mode additionally. - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. ``` diff --git a/docs/commands/list-strategies.md b/docs/commands/list-strategies.md index 95f79e175..db33f17f2 100644 --- a/docs/commands/list-strategies.md +++ b/docs/commands/list-strategies.md @@ -16,21 +16,20 @@ Common arguments: -v, --verbose Verbose mode (-vv for more, -vvv to get all messages). --no-color Disable colorization of hyperopt results. May be 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: '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: + -c, --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 + -d, --datadir, --data-dir PATH Path to the base directory of the exchange with historical backtesting data. To see futures data, use trading-mode additionally. - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. ``` diff --git a/docs/commands/list-timeframes.md b/docs/commands/list-timeframes.md index bcd45b151..2fa6f0eb9 100644 --- a/docs/commands/list-timeframes.md +++ b/docs/commands/list-timeframes.md @@ -12,21 +12,20 @@ Common arguments: -v, --verbose Verbose mode (-vv for more, -vvv to get all messages). --no-color Disable colorization of hyperopt results. May be 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: '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: + -c, --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 + -d, --datadir, --data-dir PATH Path to the base directory of the exchange with historical backtesting data. To see futures data, use trading-mode additionally. - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. ``` diff --git a/docs/commands/lookahead-analysis.md b/docs/commands/lookahead-analysis.md index e94876308..1573298a1 100644 --- a/docs/commands/lookahead-analysis.md +++ b/docs/commands/lookahead-analysis.md @@ -26,7 +26,7 @@ usage: freqtrade lookahead-analysis [-h] [-v] [--no-color] [--logfile FILE] options: -h, --help show this help message and exit - -i TIMEFRAME, --timeframe TIMEFRAME + -i, --timeframe TIMEFRAME Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`). --timerange TIMERANGE Specify what timerange of data to use. @@ -41,7 +41,7 @@ options: setting. --fee FLOAT Specify fee ratio. Will be applied twice (on trade entry and exit). - -p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...] + -p, --pairs PAIRS [PAIRS ...] Limit command to these pairs. Pairs are space- separated. --enable-protections, --enableprotections @@ -53,7 +53,7 @@ options: pairlist will be generated for each new candle if you're using a pairlist handler that supports this 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 dry-runs. --timeframe-detail TIMEFRAME_DETAIL @@ -68,13 +68,13 @@ options: becomes `backtest-data-SampleStrategy.json` --export {none,trades,signals} Export backtest results (default: trades). - --backtest-filename PATH, --export-filename PATH + --backtest-filename, --export-filename PATH Use this filename for backtest results.Example: `--backtest- filename=backtest_results_2020-09-27_16-20-48.json`. Assumes either `user_data/backtest_results/` or `--export-directory` as base directory. - --backtest-directory PATH, --export-directory PATH + --backtest-directory, --export-directory PATH Directory to use for backtest results. Example: `--export-directory=user_data/backtest_results/`. --freqai-backtest-live-models @@ -93,26 +93,24 @@ Common arguments: -v, --verbose Verbose mode (-vv for more, -vvv to get all messages). --no-color Disable colorization of hyperopt results. May be 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: '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: + -c, --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 + -d, --datadir, --data-dir PATH Path to the base directory of the exchange with historical backtesting data. To see futures data, use trading-mode additionally. - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. Strategy arguments: - -s NAME, --strategy NAME - Specify strategy class name which will be used by the + -s, --strategy NAME Specify strategy class name which will be used by the bot. --strategy-path PATH Specify additional strategy lookup path. --recursive-strategy-search diff --git a/docs/commands/main.md b/docs/commands/main.md index 673281da4..b90e5c621 100644 --- a/docs/commands/main.md +++ b/docs/commands/main.md @@ -1,7 +1,6 @@ ``` 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 diff --git a/docs/commands/new-config.md b/docs/commands/new-config.md index ec604321b..de84aeaee 100644 --- a/docs/commands/new-config.md +++ b/docs/commands/new-config.md @@ -2,11 +2,10 @@ usage: freqtrade new-config [-h] [-c PATH] options: - -h, --help show this help message 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. + -h, --help show this help message and exit + -c, --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. ``` diff --git a/docs/commands/new-strategy.md b/docs/commands/new-strategy.md index bf4bbf44f..727407b0c 100644 --- a/docs/commands/new-strategy.md +++ b/docs/commands/new-strategy.md @@ -5,10 +5,9 @@ usage: freqtrade new-strategy [-h] [--userdir PATH] [-s NAME] options: -h, --help show this help message and exit - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. - -s NAME, --strategy NAME - Specify strategy class name which will be used by the + -s, --strategy NAME Specify strategy class name which will be used by the bot. --strategy-path PATH Specify additional strategy lookup path. --template {full,minimal,advanced} diff --git a/docs/commands/plot-dataframe.md b/docs/commands/plot-dataframe.md index a709858f3..0dab89288 100644 --- a/docs/commands/plot-dataframe.md +++ b/docs/commands/plot-dataframe.md @@ -16,7 +16,7 @@ usage: freqtrade plot-dataframe [-h] [-v] [--no-color] [--logfile FILE] [-V] options: -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- separated. --indicators1 INDICATORS1 [INDICATORS1 ...] @@ -38,7 +38,7 @@ options: (backtest file)) Default: file --export {none,trades,signals} Export backtest results (default: trades). - --backtest-filename PATH, --export-filename PATH + --backtest-filename, --export-filename PATH Use this filename for backtest results.Example: `--backtest- filename=backtest_results_2020-09-27_16-20-48.json`. @@ -46,7 +46,7 @@ options: `--export-directory` as base directory. --timerange TIMERANGE Specify what timerange of data to use. - -i TIMEFRAME, --timeframe TIMEFRAME + -i, --timeframe TIMEFRAME Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`). --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). --no-color Disable colorization of hyperopt results. May be 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: '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: + -c, --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 + -d, --datadir, --data-dir PATH Path to the base directory of the exchange with historical backtesting data. To see futures data, use trading-mode additionally. - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. Strategy arguments: - -s NAME, --strategy NAME - Specify strategy class name which will be used by the + -s, --strategy NAME Specify strategy class name which will be used by the bot. --strategy-path PATH Specify additional strategy lookup path. --recursive-strategy-search diff --git a/docs/commands/plot-profit.md b/docs/commands/plot-profit.md index e46e4b223..3f8c956a4 100644 --- a/docs/commands/plot-profit.md +++ b/docs/commands/plot-profit.md @@ -12,14 +12,14 @@ usage: freqtrade plot-profit [-h] [-v] [--no-color] [--logfile FILE] [-V] options: -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- separated. --timerange TIMERANGE Specify what timerange of data to use. --export {none,trades,signals} Export backtest results (default: trades). - --backtest-filename PATH, --export-filename PATH + --backtest-filename, --export-filename PATH Use this filename for backtest results.Example: `--backtest- filename=backtest_results_2020-09-27_16-20-48.json`. @@ -32,7 +32,7 @@ options: --trade-source {DB,file} Specify the source for trades (Can be DB or file (backtest file)) Default: file - -i TIMEFRAME, --timeframe TIMEFRAME + -i, --timeframe TIMEFRAME Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`). --auto-open Automatically open generated plot. @@ -40,26 +40,24 @@ Common arguments: -v, --verbose Verbose mode (-vv for more, -vvv to get all messages). --no-color Disable colorization of hyperopt results. May be 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: '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: + -c, --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 + -d, --datadir, --data-dir PATH Path to the base directory of the exchange with historical backtesting data. To see futures data, use trading-mode additionally. - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. Strategy arguments: - -s NAME, --strategy NAME - Specify strategy class name which will be used by the + -s, --strategy NAME Specify strategy class name which will be used by the bot. --strategy-path PATH Specify additional strategy lookup path. --recursive-strategy-search diff --git a/docs/commands/recursive-analysis.md b/docs/commands/recursive-analysis.md index 39b4fc3da..e9acc8d68 100644 --- a/docs/commands/recursive-analysis.md +++ b/docs/commands/recursive-analysis.md @@ -12,14 +12,14 @@ usage: freqtrade recursive-analysis [-h] [-v] [--no-color] [--logfile FILE] options: -h, --help show this help message and exit - -i TIMEFRAME, --timeframe TIMEFRAME + -i, --timeframe TIMEFRAME Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`). --timerange TIMERANGE Specify what timerange of data to use. --data-format-ohlcv {json,jsongz,feather,parquet} Storage format for downloaded candle (OHLCV) data. (default: `feather`). - -p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...] + -p, --pairs PAIRS [PAIRS ...] Limit command to these pairs. Pairs are space- separated. --startup-candle STARTUP_CANDLE [STARTUP_CANDLE ...] @@ -30,26 +30,24 @@ Common arguments: -v, --verbose Verbose mode (-vv for more, -vvv to get all messages). --no-color Disable colorization of hyperopt results. May be 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: '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: + -c, --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 + -d, --datadir, --data-dir PATH Path to the base directory of the exchange with historical backtesting data. To see futures data, use trading-mode additionally. - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. Strategy arguments: - -s NAME, --strategy NAME - Specify strategy class name which will be used by the + -s, --strategy NAME Specify strategy class name which will be used by the bot. --strategy-path PATH Specify additional strategy lookup path. --recursive-strategy-search diff --git a/docs/commands/show-config.md b/docs/commands/show-config.md index 7ebf6fd84..b80141f0c 100644 --- a/docs/commands/show-config.md +++ b/docs/commands/show-config.md @@ -4,10 +4,9 @@ usage: freqtrade show-config [-h] [--userdir PATH] [-c PATH] options: -h, --help show this help message and exit - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. - -c PATH, --config PATH - Specify configuration file (default: + -c, --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. diff --git a/docs/commands/show-trades.md b/docs/commands/show-trades.md index 6ac64cae7..cba55be56 100644 --- a/docs/commands/show-trades.md +++ b/docs/commands/show-trades.md @@ -19,21 +19,20 @@ Common arguments: -v, --verbose Verbose mode (-vv for more, -vvv to get all messages). --no-color Disable colorization of hyperopt results. May be 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: '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: + -c, --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 + -d, --datadir, --data-dir PATH Path to the base directory of the exchange with historical backtesting data. To see futures data, use trading-mode additionally. - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. ``` diff --git a/docs/commands/strategy-updater.md b/docs/commands/strategy-updater.md index c2804fee2..4db20b032 100644 --- a/docs/commands/strategy-updater.md +++ b/docs/commands/strategy-updater.md @@ -23,21 +23,20 @@ Common arguments: -v, --verbose Verbose mode (-vv for more, -vvv to get all messages). --no-color Disable colorization of hyperopt results. May be 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: '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: + -c, --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 + -d, --datadir, --data-dir PATH Path to the base directory of the exchange with historical backtesting data. To see futures data, use trading-mode additionally. - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. ``` diff --git a/docs/commands/test-pairlist.md b/docs/commands/test-pairlist.md index 51a278b52..2dd9ff789 100644 --- a/docs/commands/test-pairlist.md +++ b/docs/commands/test-pairlist.md @@ -5,11 +5,10 @@ usage: freqtrade test-pairlist [-h] [--userdir PATH] [-v] [-c PATH] options: -h, --help show this help message and exit - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. -v, --verbose Verbose mode (-vv for more, -vvv to get all messages). - -c PATH, --config PATH - Specify configuration file (default: + -c, --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. diff --git a/docs/commands/trade.md b/docs/commands/trade.md index 0189669c0..0a0719ba0 100644 --- a/docs/commands/trade.md +++ b/docs/commands/trade.md @@ -15,7 +15,7 @@ options: --sd-notify Notify systemd service manager. --dry-run Enforce dry-run for trading (removes Exchange secrets 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 dry-runs. --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). --no-color Disable colorization of hyperopt results. May be 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: '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: + -c, --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 + -d, --datadir, --data-dir PATH Path to the base directory of the exchange with historical backtesting data. To see futures data, use trading-mode additionally. - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. Strategy arguments: - -s NAME, --strategy NAME - Specify strategy class name which will be used by the + -s, --strategy NAME Specify strategy class name which will be used by the bot. --strategy-path PATH Specify additional strategy lookup path. --recursive-strategy-search diff --git a/docs/commands/trades-to-ohlcv.md b/docs/commands/trades-to-ohlcv.md index 748a8ace5..c318841cd 100644 --- a/docs/commands/trades-to-ohlcv.md +++ b/docs/commands/trades-to-ohlcv.md @@ -10,10 +10,10 @@ usage: freqtrade trades-to-ohlcv [-h] [-v] [--no-color] [--logfile FILE] [-V] options: -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- separated. - -t TIMEFRAMES [TIMEFRAMES ...], --timeframes TIMEFRAMES [TIMEFRAMES ...] + -t, --timeframes TIMEFRAMES [TIMEFRAMES ...] Specify which tickers to download. Space-separated list. Default: `1m 5m`. --exchange EXCHANGE Exchange name. Only valid if no config is provided. @@ -23,28 +23,27 @@ options: --data-format-trades {json,jsongz,feather,parquet} Storage format for downloaded trades data. (default: `feather`). - --trading-mode {spot,margin,futures}, --tradingmode {spot,margin,futures} + --trading-mode, --tradingmode {spot,margin,futures} Select Trading mode Common arguments: -v, --verbose Verbose mode (-vv for more, -vvv to get all messages). --no-color Disable colorization of hyperopt results. May be 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: '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: + -c, --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 + -d, --datadir, --data-dir PATH Path to the base directory of the exchange with historical backtesting data. To see futures data, use trading-mode additionally. - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. ``` diff --git a/docs/commands/webserver.md b/docs/commands/webserver.md index 1ac7bd13b..cd42e9825 100644 --- a/docs/commands/webserver.md +++ b/docs/commands/webserver.md @@ -9,21 +9,20 @@ Common arguments: -v, --verbose Verbose mode (-vv for more, -vvv to get all messages). --no-color Disable colorization of hyperopt results. May be 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: '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: + -c, --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 + -d, --datadir, --data-dir PATH Path to the base directory of the exchange with historical backtesting data. To see futures data, use trading-mode additionally. - --userdir PATH, --user-data-dir PATH + --userdir, --user-data-dir PATH Path to userdata directory. ```