From e26c3cbe5acb797a0be9d1bcc1d95274fdef4dd8 Mon Sep 17 00:00:00 2001 From: Matthias Date: Sun, 9 Nov 2025 08:07:16 +0100 Subject: [PATCH 1/8] chore: update CI to create partials on 3.13 --- .github/workflows/ci.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 24c4e97c9..7b6d061b0 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -91,12 +91,12 @@ jobs: - name: Run command docs partials extract # This should be kept before the repository check to ensure that the docs are up-to-date + if: ${{ (matrix.python-version != '3.13') }} run: | python build_helpers/create_command_partials.py - name: Check for repository changes - *nix - # TODO: python 3.13 slightly changed the output of argparse. - if: ${{ (matrix.python-version != '3.13') && (runner.os != 'Windows') }} + if: ${{ (runner.os != 'Windows') }} run: | if [ -n "$(git status --porcelain)" ]; then echo "Repository is dirty, changes detected:" From 5d494eac51c4f27d2aece9b10c901de8f95dba8c Mon Sep 17 00:00:00 2001 From: Matthias Date: Sun, 9 Nov 2025 08:07:37 +0100 Subject: [PATCH 2/8] docs: update command partials to be created with python 3.13 --- docs/commands/backtesting-analysis.md | 13 ++++++------- docs/commands/backtesting-show.md | 13 ++++++------- docs/commands/backtesting.md | 22 ++++++++++------------ docs/commands/convert-data.md | 23 +++++++++++------------ docs/commands/convert-trade-data.md | 15 +++++++-------- docs/commands/create-userdir.md | 2 +- docs/commands/download-data.md | 15 +++++++-------- docs/commands/edge.md | 16 +++++++--------- docs/commands/hyperopt-list.md | 9 ++++----- docs/commands/hyperopt-show.md | 11 +++++------ docs/commands/hyperopt.md | 24 +++++++++++------------- docs/commands/list-data.md | 13 ++++++------- docs/commands/list-exchanges.md | 11 +++++------ docs/commands/list-freqaimodels.md | 9 ++++----- docs/commands/list-hyperoptloss.md | 9 ++++----- docs/commands/list-markets.md | 11 +++++------ docs/commands/list-pairs.md | 11 +++++------ docs/commands/list-strategies.md | 9 ++++----- docs/commands/list-timeframes.md | 9 ++++----- docs/commands/lookahead-analysis.md | 22 ++++++++++------------ docs/commands/main.md | 3 +-- docs/commands/new-config.md | 11 +++++------ docs/commands/new-strategy.md | 5 ++--- docs/commands/plot-dataframe.md | 18 ++++++++---------- docs/commands/plot-profit.md | 18 ++++++++---------- docs/commands/recursive-analysis.md | 16 +++++++--------- docs/commands/show-config.md | 5 ++--- docs/commands/show-trades.md | 9 ++++----- docs/commands/strategy-updater.md | 9 ++++----- docs/commands/test-pairlist.md | 5 ++--- docs/commands/trade.md | 14 ++++++-------- docs/commands/trades-to-ohlcv.md | 15 +++++++-------- docs/commands/webserver.md | 9 ++++----- 33 files changed, 182 insertions(+), 222 deletions(-) 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. ``` From 2846d9478ef670de5f2ae6bba7083024463851e2 Mon Sep 17 00:00:00 2001 From: Matthias Date: Sun, 9 Nov 2025 08:30:38 +0100 Subject: [PATCH 3/8] chore: fix ci condition --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 7b6d061b0..dddce1734 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -91,7 +91,7 @@ jobs: - name: Run command docs partials extract # This should be kept before the repository check to ensure that the docs are up-to-date - if: ${{ (matrix.python-version != '3.13') }} + if: ${{ (matrix.python-version == '3.13') }} run: | python build_helpers/create_command_partials.py From 777ff1938eeb41f02d51723d9109a16b6f6cd1ca Mon Sep 17 00:00:00 2001 From: Matthias Date: Sun, 9 Nov 2025 08:36:42 +0100 Subject: [PATCH 4/8] feat: extract freqtrade-client to auto-use help --- build_helpers/create_command_partials.py | 7 + docs/commands/freqtrade-client.md | 197 +++++++++++++++++++++++ docs/rest-api.md | 178 +------------------- 3 files changed, 207 insertions(+), 175 deletions(-) create mode 100644 docs/commands/freqtrade-client.md diff --git a/build_helpers/create_command_partials.py b/build_helpers/create_command_partials.py index 97bec3a7d..4c58ddb9c 100644 --- a/build_helpers/create_command_partials.py +++ b/build_helpers/create_command_partials.py @@ -51,3 +51,10 @@ for command in subcommands: with Path(f"docs/commands/{command}.md").open("w") as f: f.write(f"```\n{result.stdout}\n```\n") + + +print("Running for freqtrade-client") +result_client = subprocess.run(["freqtrade-client", "--show"], capture_output=True, text=True) + +with Path("docs/commands/freqtrade-client.md").open("w") as f: + f.write(f"```\n{result_client.stdout}\n```\n") diff --git a/docs/commands/freqtrade-client.md b/docs/commands/freqtrade-client.md new file mode 100644 index 000000000..84176f6f8 --- /dev/null +++ b/docs/commands/freqtrade-client.md @@ -0,0 +1,197 @@ +``` +Possible commands: + +available_pairs + Return available pair (backtest data) based on timeframe / stake_currency selection + +:param timeframe: Only pairs with this timeframe available. +:param stake_currency: Only pairs that include this stake currency. + +balance + Get the account balance. + +blacklist + Show the current blacklist. + +:param add: List of coins to add (example: "BNB/BTC") + +cancel_open_order + Cancel open order for trade. + +:param trade_id: Cancels open orders for this trade. + +count + Return the amount of open trades. + +daily + Return the profits for each day, and amount of trades. + +delete_lock + Delete (disable) lock from the database. + +:param lock_id: ID for the lock to delete + +delete_trade + Delete trade from the database. +Tries to close open orders. Requires manual handling of this asset on the exchange. + +:param trade_id: Deletes the trade with this ID from the database. + +entries + Returns List of dicts containing all Trades, based on buy tag performance +Can either be average for all pairs or a specific pair provided + +exits + Returns List of dicts containing all Trades, based on exit reason performance +Can either be average for all pairs or a specific pair provided + +forcebuy + Buy an asset. + +:param pair: Pair to buy (ETH/BTC) +:param price: Optional - price to buy + +forceenter + Force entering a trade + +:param pair: Pair to buy (ETH/BTC) +:param side: 'long' or 'short' +:param price: Optional - price to buy +:param order_type: Optional keyword argument - 'limit' or 'market' +:param stake_amount: Optional keyword argument - stake amount (as float) +:param leverage: Optional keyword argument - leverage (as float) +:param enter_tag: Optional keyword argument - entry tag (as string, default: 'force_enter') + +forceexit + Force-exit a trade. + +:param tradeid: Id of the trade (can be received via status command) +:param ordertype: Order type to use (must be market or limit) +:param amount: Amount to sell. Full sell if not given + +health + Provides a quick health check of the running bot. + +list_custom_data + List custom-data of the running bot for a specific trade. + +:param trade_id: ID of the trade +:param key: str, optional - Key of the custom-data + +list_open_trades_custom_data + List open trades custom-data of the running bot. + +:param key: str, optional - Key of the custom-data +:param limit: limit of trades +:param offset: trades offset for pagination + +lock_add + Lock pair + +:param pair: Pair to lock +:param until: Lock until this date (format "2024-03-30 16:00:00Z") +:param side: Side to lock (long, short, *) +:param reason: Reason for the lock + +locks + Return current locks + +logs + Show latest logs. + +:param limit: Limits log messages to the last logs. No limit to get the entire log. + +mix_tags + Returns List of dicts containing all Trades, based on entry_tag + exit_reason performance +Can either be average for all pairs or a specific pair provided + +monthly + Return the profits for each month, and amount of trades. + +pair_candles + Return live dataframe for . + +:param pair: Pair to get data for +:param timeframe: Only pairs with this timeframe available. +:param limit: Limit result to the last n candles. +:param columns: List of dataframe columns to return. Empty list will return OHLCV. + +pair_history + Return historic, analyzed dataframe + +:param pair: Pair to get data for +:param timeframe: Only pairs with this timeframe available. +:param strategy: Strategy to analyze and get values for +:param freqaimodel: FreqAI model to use for analysis +:param timerange: Timerange to get data for (same format than --timerange endpoints) + +pairlists_available + Lists available pairlist providers + +performance + Return the performance of the different coins. + +ping + simple ping + +plot_config + Return plot configuration if the strategy defines one. + +profit + Return the profit summary. + +reload_config + Reload configuration. + +show_config + Returns part of the configuration, relevant for trading operations. + +start + Start the bot if it's in the stopped state. + +stats + Return the stats report (durations, sell-reasons). + +status + Get the status of open trades. + +stop + Stop the bot. Use `start` to restart. + +stopbuy + Stop buying (but handle sells gracefully). Use `reload_config` to reset. + +strategies + Lists available strategies + +strategy + Get strategy details + +:param strategy: Strategy class name + +sysinfo + Provides system information (CPU, RAM usage) + +trade + Return specific trade + +:param trade_id: Specify which trade to get. + +trades + Return trades history, sorted by id (or by latest timestamp if order_by_id=False) + +:param limit: Limits trades to the X last trades. Max 500 trades. +:param offset: Offset by this amount of trades. +:param order_by_id: Sort trades by id (default: True). If False, sorts by latest timestamp. + +version + Return the version of the bot. + +weekly + Return the profits for each week, and amount of trades. + +whitelist + Show the current whitelist. + + +``` diff --git a/docs/rest-api.md b/docs/rest-api.md index eac8d54bc..f41a2ebe4 100644 --- a/docs/rest-api.md +++ b/docs/rest-api.md @@ -150,188 +150,16 @@ This method will work for all arguments - check the "show" command for a list of For a full list of available commands, please refer to the list below. +#### Freqtrade client- available commands + Possible commands can be listed from the rest-client script using the `help` command. ``` bash freqtrade-client help ``` -``` output -Possible commands: +--8<-- "commands/freqtrade-client.md" -available_pairs - Return available pair (backtest data) based on timeframe / stake_currency selection - - :param timeframe: Only pairs with this timeframe available. - :param stake_currency: Only pairs that include this timeframe - -balance - Get the account balance. - -blacklist - Show the current blacklist. - - :param add: List of coins to add (example: "BNB/BTC") - -cancel_open_order - Cancel open order for trade. - - :param trade_id: Cancels open orders for this trade. - -count - Return the amount of open trades. - -daily - Return the profits for each day, and amount of trades. - -delete_lock - Delete (disable) lock from the database. - - :param lock_id: ID for the lock to delete - -delete_trade - Delete trade from the database. - Tries to close open orders. Requires manual handling of this asset on the exchange. - - :param trade_id: Deletes the trade with this ID from the database. - -forcebuy - Buy an asset. - - :param pair: Pair to buy (ETH/BTC) - :param price: Optional - price to buy - -forceenter - Force entering a trade - - :param pair: Pair to buy (ETH/BTC) - :param side: 'long' or 'short' - :param price: Optional - price to buy - :param order_type: Optional keyword argument - 'limit' or 'market' - :param stake_amount: Optional keyword argument - stake amount (as float) - :param leverage: Optional keyword argument - leverage (as float) - :param enter_tag: Optional keyword argument - entry tag (as string, default: 'force_enter') - -forceexit - Force-exit a trade. - - :param tradeid: Id of the trade (can be received via status command) - :param ordertype: Order type to use (must be market or limit) - :param amount: Amount to sell. Full sell if not given - -health - Provides a quick health check of the running bot. - -lock_add - Manually lock a specific pair - - :param pair: Pair to lock - :param until: Lock until this date (format "2024-03-30 16:00:00Z") - :param side: Side to lock (long, short, *) - :param reason: Reason for the lock - -locks - Return current locks - -logs - Show latest logs. - - :param limit: Limits log messages to the last logs. No limit to get the entire log. - -pair_candles - Return live dataframe for . - - :param pair: Pair to get data for - :param timeframe: Only pairs with this timeframe available. - :param limit: Limit result to the last n candles. - -pair_history - Return historic, analyzed dataframe - - :param pair: Pair to get data for - :param timeframe: Only pairs with this timeframe available. - :param strategy: Strategy to analyze and get values for - :param timerange: Timerange to get data for (same format than --timerange endpoints) - -performance - Return the performance of the different coins. - -ping - simple ping - -plot_config - Return plot configuration if the strategy defines one. - -profit - Return the profit summary. - -reload_config - Reload configuration. - -show_config - Returns part of the configuration, relevant for trading operations. - -start - Start the bot if it's in the stopped state. - -pause - Pause the bot if it's in the running state. If triggered on stopped state will handle open positions. - -stats - Return the stats report (durations, sell-reasons). - -status - Get the status of open trades. - -stop - Stop the bot. Use `start` to restart. - -stopbuy - Stop buying (but handle sells gracefully). Use `reload_config` to reset. - -strategies - Lists available strategies - -strategy - Get strategy details - - :param strategy: Strategy class name - -sysinfo - Provides system information (CPU, RAM usage) - -trade - Return specific trade - - :param trade_id: Specify which trade to get. - -trades - Return trades history, sorted by id - - :param limit: Limits trades to the X last trades. Max 500 trades. - :param offset: Offset by this amount of trades. - -list_open_trades_custom_data - Return a dict containing open trades custom-datas - - :param key: str, optional - Key of the custom-data - :param limit: Limits trades to X trades. - :param offset: Offset by this amount of trades. - -list_custom_data - Return a dict containing custom-datas of a specified trade - - :param trade_id: int - ID of the trade - :param key: str, optional - Key of the custom-data - -version - Return the version of the bot. - -whitelist - Show the current whitelist. - - -``` ### Available endpoints From d246933c284f50467b0b1a8a0db8d9db408d9866 Mon Sep 17 00:00:00 2001 From: Matthias Date: Sun, 9 Nov 2025 08:37:39 +0100 Subject: [PATCH 5/8] refactor: improve partials script --- build_helpers/create_command_partials.py | 103 ++++++++++++----------- 1 file changed, 53 insertions(+), 50 deletions(-) diff --git a/build_helpers/create_command_partials.py b/build_helpers/create_command_partials.py index 4c58ddb9c..4705f72cf 100644 --- a/build_helpers/create_command_partials.py +++ b/build_helpers/create_command_partials.py @@ -2,59 +2,62 @@ import subprocess # noqa: S404, RUF100 from pathlib import Path -subcommands = [ - "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", -] +def extract_command_partials(): + subcommands = [ + "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", + ] -result = subprocess.run(["freqtrade", "--help"], capture_output=True, text=True) + result = subprocess.run(["freqtrade", "--help"], capture_output=True, text=True) -with Path("docs/commands/main.md").open("w") as f: - f.write(f"```\n{result.stdout}\n```\n") - - -for command in subcommands: - print(f"Running for {command}") - result = subprocess.run(["freqtrade", command, "--help"], capture_output=True, text=True) - - with Path(f"docs/commands/{command}.md").open("w") as f: + with Path("docs/commands/main.md").open("w") as f: f.write(f"```\n{result.stdout}\n```\n") + for command in subcommands: + print(f"Running for {command}") + result = subprocess.run(["freqtrade", command, "--help"], capture_output=True, text=True) -print("Running for freqtrade-client") -result_client = subprocess.run(["freqtrade-client", "--show"], capture_output=True, text=True) + with Path(f"docs/commands/{command}.md").open("w") as f: + f.write(f"```\n{result.stdout}\n```\n") -with Path("docs/commands/freqtrade-client.md").open("w") as f: - f.write(f"```\n{result_client.stdout}\n```\n") + print("Running for freqtrade-client") + result_client = subprocess.run(["freqtrade-client", "--show"], capture_output=True, text=True) + + with Path("docs/commands/freqtrade-client.md").open("w") as f: + f.write(f"```\n{result_client.stdout}\n```\n") + + +if __name__ == "__main__": + extract_command_partials() From 880485017016bac1a939e56d29d075516666b799 Mon Sep 17 00:00:00 2001 From: Matthias Date: Sun, 9 Nov 2025 08:38:26 +0100 Subject: [PATCH 6/8] refactor: extract partial-file writing --- build_helpers/create_command_partials.py | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/build_helpers/create_command_partials.py b/build_helpers/create_command_partials.py index 4705f72cf..13dc603d1 100644 --- a/build_helpers/create_command_partials.py +++ b/build_helpers/create_command_partials.py @@ -2,6 +2,11 @@ import subprocess # noqa: S404, RUF100 from pathlib import Path +def _write_partial_file(filename: str, content: str): + with Path(filename).open("w") as f: + f.write(f"```\n{content}\n```\n") + + def extract_command_partials(): subcommands = [ "trade", @@ -42,21 +47,18 @@ def extract_command_partials(): result = subprocess.run(["freqtrade", "--help"], capture_output=True, text=True) - with Path("docs/commands/main.md").open("w") as f: - f.write(f"```\n{result.stdout}\n```\n") + _write_partial_file("docs/commands/main.md", result.stdout) for command in subcommands: print(f"Running for {command}") result = subprocess.run(["freqtrade", command, "--help"], capture_output=True, text=True) - with Path(f"docs/commands/{command}.md").open("w") as f: - f.write(f"```\n{result.stdout}\n```\n") + _write_partial_file(f"docs/commands/{command}.md", result.stdout) print("Running for freqtrade-client") result_client = subprocess.run(["freqtrade-client", "--show"], capture_output=True, text=True) - with Path("docs/commands/freqtrade-client.md").open("w") as f: - f.write(f"```\n{result_client.stdout}\n```\n") + _write_partial_file("docs/commands/freqtrade-client.md", result_client.stdout) if __name__ == "__main__": From 40107b93800e5b75edbac698316e2dea32a41805 Mon Sep 17 00:00:00 2001 From: Matthias Date: Sun, 9 Nov 2025 08:40:26 +0100 Subject: [PATCH 7/8] feat: format partials codeblock as outputs --- build_helpers/create_command_partials.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build_helpers/create_command_partials.py b/build_helpers/create_command_partials.py index 13dc603d1..dc69117b7 100644 --- a/build_helpers/create_command_partials.py +++ b/build_helpers/create_command_partials.py @@ -4,7 +4,7 @@ from pathlib import Path def _write_partial_file(filename: str, content: str): with Path(filename).open("w") as f: - f.write(f"```\n{content}\n```\n") + f.write(f"``` output\n{content}\n```\n") def extract_command_partials(): From b6b817e051e0f2ffa6119d17c2d32029b1648867 Mon Sep 17 00:00:00 2001 From: Matthias Date: Sun, 9 Nov 2025 08:41:02 +0100 Subject: [PATCH 8/8] chore: re-export all command partials --- docs/commands/backtesting-analysis.md | 2 +- docs/commands/backtesting-show.md | 2 +- docs/commands/backtesting.md | 2 +- docs/commands/convert-data.md | 2 +- docs/commands/convert-db.md | 2 +- docs/commands/convert-trade-data.md | 2 +- docs/commands/create-userdir.md | 2 +- docs/commands/download-data.md | 2 +- docs/commands/edge.md | 2 +- docs/commands/freqtrade-client.md | 2 +- docs/commands/hyperopt-list.md | 2 +- docs/commands/hyperopt-show.md | 2 +- docs/commands/hyperopt.md | 2 +- docs/commands/install-ui.md | 2 +- docs/commands/list-data.md | 2 +- docs/commands/list-exchanges.md | 2 +- docs/commands/list-freqaimodels.md | 2 +- docs/commands/list-hyperoptloss.md | 2 +- docs/commands/list-markets.md | 2 +- docs/commands/list-pairs.md | 2 +- docs/commands/list-strategies.md | 2 +- docs/commands/list-timeframes.md | 2 +- docs/commands/lookahead-analysis.md | 2 +- docs/commands/main.md | 2 +- docs/commands/new-config.md | 2 +- docs/commands/new-strategy.md | 2 +- docs/commands/plot-dataframe.md | 2 +- docs/commands/plot-profit.md | 2 +- docs/commands/recursive-analysis.md | 2 +- docs/commands/show-config.md | 2 +- docs/commands/show-trades.md | 2 +- docs/commands/strategy-updater.md | 2 +- docs/commands/test-pairlist.md | 2 +- docs/commands/trade.md | 2 +- docs/commands/trades-to-ohlcv.md | 2 +- docs/commands/webserver.md | 2 +- 36 files changed, 36 insertions(+), 36 deletions(-) diff --git a/docs/commands/backtesting-analysis.md b/docs/commands/backtesting-analysis.md index d77979432..d208a3173 100644 --- a/docs/commands/backtesting-analysis.md +++ b/docs/commands/backtesting-analysis.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade backtesting-analysis [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] diff --git a/docs/commands/backtesting-show.md b/docs/commands/backtesting-show.md index 3574f4dd5..d4734b5b0 100644 --- a/docs/commands/backtesting-show.md +++ b/docs/commands/backtesting-show.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade backtesting-show [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [--backtest-filename PATH] diff --git a/docs/commands/backtesting.md b/docs/commands/backtesting.md index 3554bb8d8..6e82d4233 100644 --- a/docs/commands/backtesting.md +++ b/docs/commands/backtesting.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade backtesting [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [-s NAME] [--strategy-path PATH] diff --git a/docs/commands/convert-data.md b/docs/commands/convert-data.md index ea2c8f7ae..899babb39 100644 --- a/docs/commands/convert-data.md +++ b/docs/commands/convert-data.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade convert-data [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [-p PAIRS [PAIRS ...]] diff --git a/docs/commands/convert-db.md b/docs/commands/convert-db.md index fcaab3192..21045cd8e 100644 --- a/docs/commands/convert-db.md +++ b/docs/commands/convert-db.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade convert-db [-h] [--db-url PATH] [--db-url-from PATH] options: diff --git a/docs/commands/convert-trade-data.md b/docs/commands/convert-trade-data.md index 7a28e1399..67fa0ca7c 100644 --- a/docs/commands/convert-trade-data.md +++ b/docs/commands/convert-trade-data.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade convert-trade-data [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [-p PAIRS [PAIRS ...]] diff --git a/docs/commands/create-userdir.md b/docs/commands/create-userdir.md index 6351ffcea..734682aaf 100644 --- a/docs/commands/create-userdir.md +++ b/docs/commands/create-userdir.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade create-userdir [-h] [--userdir PATH] [--reset] options: diff --git a/docs/commands/download-data.md b/docs/commands/download-data.md index 87ec88080..35f15d19d 100644 --- a/docs/commands/download-data.md +++ b/docs/commands/download-data.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade download-data [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [-p PAIRS [PAIRS ...]] [--pairs-file FILE] diff --git a/docs/commands/edge.md b/docs/commands/edge.md index 7851c8c24..5f8d68ad4 100644 --- a/docs/commands/edge.md +++ b/docs/commands/edge.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade edge [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [-s NAME] [--strategy-path PATH] [--recursive-strategy-search] diff --git a/docs/commands/freqtrade-client.md b/docs/commands/freqtrade-client.md index 84176f6f8..0f593656e 100644 --- a/docs/commands/freqtrade-client.md +++ b/docs/commands/freqtrade-client.md @@ -1,4 +1,4 @@ -``` +``` output Possible commands: available_pairs diff --git a/docs/commands/hyperopt-list.md b/docs/commands/hyperopt-list.md index a58caddea..17d1736d0 100644 --- a/docs/commands/hyperopt-list.md +++ b/docs/commands/hyperopt-list.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade hyperopt-list [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [--best] [--profitable] [--min-trades INT] diff --git a/docs/commands/hyperopt-show.md b/docs/commands/hyperopt-show.md index d82f5283f..933fc7b39 100644 --- a/docs/commands/hyperopt-show.md +++ b/docs/commands/hyperopt-show.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade hyperopt-show [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [--best] [--profitable] [-n INT] [--print-json] diff --git a/docs/commands/hyperopt.md b/docs/commands/hyperopt.md index b5032f4b9..07a286a8e 100644 --- a/docs/commands/hyperopt.md +++ b/docs/commands/hyperopt.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade hyperopt [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [-s NAME] [--strategy-path PATH] [--recursive-strategy-search] diff --git a/docs/commands/install-ui.md b/docs/commands/install-ui.md index b8430e36e..0801ee70d 100644 --- a/docs/commands/install-ui.md +++ b/docs/commands/install-ui.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade install-ui [-h] [--erase] [--prerelease] [--ui-version UI_VERSION] diff --git a/docs/commands/list-data.md b/docs/commands/list-data.md index f56febd28..6d85efcff 100644 --- a/docs/commands/list-data.md +++ b/docs/commands/list-data.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade list-data [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [--exchange EXCHANGE] diff --git a/docs/commands/list-exchanges.md b/docs/commands/list-exchanges.md index 41c45302a..4c90810b9 100644 --- a/docs/commands/list-exchanges.md +++ b/docs/commands/list-exchanges.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade list-exchanges [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [-1] [-a] [--trading-mode {spot,margin,futures}] diff --git a/docs/commands/list-freqaimodels.md b/docs/commands/list-freqaimodels.md index d82bc5ac0..eea3b655f 100644 --- a/docs/commands/list-freqaimodels.md +++ b/docs/commands/list-freqaimodels.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade list-freqaimodels [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [--freqaimodel-path PATH] [-1] diff --git a/docs/commands/list-hyperoptloss.md b/docs/commands/list-hyperoptloss.md index 149eaf2f0..949f0e636 100644 --- a/docs/commands/list-hyperoptloss.md +++ b/docs/commands/list-hyperoptloss.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade list-hyperoptloss [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [--hyperopt-path PATH] [-1] diff --git a/docs/commands/list-markets.md b/docs/commands/list-markets.md index d0d97c00c..57abd4ac4 100644 --- a/docs/commands/list-markets.md +++ b/docs/commands/list-markets.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade list-markets [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [--exchange EXCHANGE] [--print-list] diff --git a/docs/commands/list-pairs.md b/docs/commands/list-pairs.md index e2e5a0085..94c766c97 100644 --- a/docs/commands/list-pairs.md +++ b/docs/commands/list-pairs.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade list-pairs [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [--exchange EXCHANGE] [--print-list] diff --git a/docs/commands/list-strategies.md b/docs/commands/list-strategies.md index db33f17f2..7b2f7556e 100644 --- a/docs/commands/list-strategies.md +++ b/docs/commands/list-strategies.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade list-strategies [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [--strategy-path PATH] [-1] diff --git a/docs/commands/list-timeframes.md b/docs/commands/list-timeframes.md index 2fa6f0eb9..a2c3a4f67 100644 --- a/docs/commands/list-timeframes.md +++ b/docs/commands/list-timeframes.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade list-timeframes [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [--exchange EXCHANGE] [-1] diff --git a/docs/commands/lookahead-analysis.md b/docs/commands/lookahead-analysis.md index 1573298a1..6ac516693 100644 --- a/docs/commands/lookahead-analysis.md +++ b/docs/commands/lookahead-analysis.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade lookahead-analysis [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [-s NAME] [--strategy-path PATH] diff --git a/docs/commands/main.md b/docs/commands/main.md index b90e5c621..0a185f86d 100644 --- a/docs/commands/main.md +++ b/docs/commands/main.md @@ -1,4 +1,4 @@ -``` +``` output 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} ... diff --git a/docs/commands/new-config.md b/docs/commands/new-config.md index de84aeaee..2e6fd0380 100644 --- a/docs/commands/new-config.md +++ b/docs/commands/new-config.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade new-config [-h] [-c PATH] options: diff --git a/docs/commands/new-strategy.md b/docs/commands/new-strategy.md index 727407b0c..9cdf124ce 100644 --- a/docs/commands/new-strategy.md +++ b/docs/commands/new-strategy.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade new-strategy [-h] [--userdir PATH] [-s NAME] [--strategy-path PATH] [--template {full,minimal,advanced}] diff --git a/docs/commands/plot-dataframe.md b/docs/commands/plot-dataframe.md index 0dab89288..fcdb5289b 100644 --- a/docs/commands/plot-dataframe.md +++ b/docs/commands/plot-dataframe.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade plot-dataframe [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [-s NAME] [--strategy-path PATH] diff --git a/docs/commands/plot-profit.md b/docs/commands/plot-profit.md index 3f8c956a4..fb605631d 100644 --- a/docs/commands/plot-profit.md +++ b/docs/commands/plot-profit.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade plot-profit [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [-s NAME] [--strategy-path PATH] diff --git a/docs/commands/recursive-analysis.md b/docs/commands/recursive-analysis.md index e9acc8d68..54ad8bf28 100644 --- a/docs/commands/recursive-analysis.md +++ b/docs/commands/recursive-analysis.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade recursive-analysis [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [-s NAME] [--strategy-path PATH] diff --git a/docs/commands/show-config.md b/docs/commands/show-config.md index b80141f0c..0f1f998a8 100644 --- a/docs/commands/show-config.md +++ b/docs/commands/show-config.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade show-config [-h] [--userdir PATH] [-c PATH] [--show-sensitive] diff --git a/docs/commands/show-trades.md b/docs/commands/show-trades.md index cba55be56..e539abaa0 100644 --- a/docs/commands/show-trades.md +++ b/docs/commands/show-trades.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade show-trades [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [--db-url PATH] diff --git a/docs/commands/strategy-updater.md b/docs/commands/strategy-updater.md index 4db20b032..051b03277 100644 --- a/docs/commands/strategy-updater.md +++ b/docs/commands/strategy-updater.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade strategy-updater [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [--strategy-list STRATEGY_LIST [STRATEGY_LIST ...]] diff --git a/docs/commands/test-pairlist.md b/docs/commands/test-pairlist.md index 2dd9ff789..575762141 100644 --- a/docs/commands/test-pairlist.md +++ b/docs/commands/test-pairlist.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade test-pairlist [-h] [--userdir PATH] [-v] [-c PATH] [--quote QUOTE_CURRENCY [QUOTE_CURRENCY ...]] [-1] [--print-json] [--exchange EXCHANGE] diff --git a/docs/commands/trade.md b/docs/commands/trade.md index 0a0719ba0..4c2bdd446 100644 --- a/docs/commands/trade.md +++ b/docs/commands/trade.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade trade [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [-s NAME] [--strategy-path PATH] [--recursive-strategy-search] diff --git a/docs/commands/trades-to-ohlcv.md b/docs/commands/trades-to-ohlcv.md index c318841cd..90548a7cf 100644 --- a/docs/commands/trades-to-ohlcv.md +++ b/docs/commands/trades-to-ohlcv.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade trades-to-ohlcv [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [-p PAIRS [PAIRS ...]] diff --git a/docs/commands/webserver.md b/docs/commands/webserver.md index cd42e9825..cb494f88c 100644 --- a/docs/commands/webserver.md +++ b/docs/commands/webserver.md @@ -1,4 +1,4 @@ -``` +``` output usage: freqtrade webserver [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH]