From 7e4b9d7481890cd543251344612daecb6ece5b06 Mon Sep 17 00:00:00 2001 From: Matthias Date: Sun, 17 Aug 2025 15:09:12 +0200 Subject: [PATCH] docs: update doc segments with new help text --- docs/commands/backtesting-analysis.md | 9 ++++++++- docs/commands/backtesting-show.md | 10 ++++++++-- docs/commands/backtesting.md | 9 ++++++++- docs/commands/lookahead-analysis.md | 9 ++++++++- docs/commands/plot-dataframe.md | 5 ++++- docs/commands/plot-profit.md | 5 ++++- 6 files changed, 40 insertions(+), 7 deletions(-) diff --git a/docs/commands/backtesting-analysis.md b/docs/commands/backtesting-analysis.md index f6e79e858..35462d18c 100644 --- a/docs/commands/backtesting-analysis.md +++ b/docs/commands/backtesting-analysis.md @@ -3,6 +3,7 @@ usage: freqtrade backtesting-analysis [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [--backtest-filename PATH] + [--export-directory PATH] [--analysis-groups {0,1,2,3,4,5} [{0,1,2,3,4,5} ...]] [--enter-reason-list ENTER_REASON_LIST [ENTER_REASON_LIST ...]] [--exit-reason-list EXIT_REASON_LIST [EXIT_REASON_LIST ...]] @@ -16,7 +17,13 @@ options: -h, --help show this help message and exit --backtest-filename PATH, --export-filename PATH Use this filename for backtest results.Example: - `--backtest-filename=user_data/backtest_results/` + `--backtest- + filename=backtest_results_2020-09-27_16-20-48.json`. + Assumes either user_data/backtest_results/ or + `--export-directory` as base directory. + --export-directory PATH, --backtest-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} ...] grouping output - 0: simple wins/losses by enter tag, 1: by enter_tag, 2: by enter_tag and exit_tag, 3: by diff --git a/docs/commands/backtesting-show.md b/docs/commands/backtesting-show.md index 5e156b4a9..3a1b4be2b 100644 --- a/docs/commands/backtesting-show.md +++ b/docs/commands/backtesting-show.md @@ -2,14 +2,20 @@ usage: freqtrade backtesting-show [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [--backtest-filename PATH] - [--show-pair-list] + [--export-directory PATH] [--show-pair-list] [--breakdown {day,week,month,year} [{day,week,month,year} ...]] options: -h, --help show this help message and exit --backtest-filename PATH, --export-filename PATH Use this filename for backtest results.Example: - `--backtest-filename=user_data/backtest_results/` + `--backtest- + filename=backtest_results_2020-09-27_16-20-48.json`. + Assumes either user_data/backtest_results/ or + `--export-directory` as base directory. + --export-directory PATH, --backtest-directory PATH + Directory to use for backtest results. Example: + `--export-directory=user_data/backtest_results/`. --show-pair-list Show backtesting pairlist sorted by profit. --breakdown {day,week,month,year} [{day,week,month,year} ...] Show backtesting breakdown per [day, week, month, diff --git a/docs/commands/backtesting.md b/docs/commands/backtesting.md index 70c2c51c9..55ed392d8 100644 --- a/docs/commands/backtesting.md +++ b/docs/commands/backtesting.md @@ -15,6 +15,7 @@ usage: freqtrade backtesting [-h] [-v] [--no-color] [--logfile FILE] [-V] [--strategy-list STRATEGY_LIST [STRATEGY_LIST ...]] [--export {none,trades,signals}] [--backtest-filename PATH] + [--export-directory PATH] [--breakdown {day,week,month,year} [{day,week,month,year} ...]] [--cache {none,day,week,month}] [--freqai-backtest-live-models] [--notes TEXT] @@ -63,7 +64,13 @@ options: Export backtest results (default: trades). --backtest-filename PATH, --export-filename PATH Use this filename for backtest results.Example: - `--backtest-filename=user_data/backtest_results/` + `--backtest- + filename=backtest_results_2020-09-27_16-20-48.json`. + Assumes either user_data/backtest_results/ or + `--export-directory` as base directory. + --export-directory PATH, --backtest-directory PATH + Directory to use for backtest results. Example: + `--export-directory=user_data/backtest_results/`. --breakdown {day,week,month,year} [{day,week,month,year} ...] Show backtesting breakdown per [day, week, month, year]. diff --git a/docs/commands/lookahead-analysis.md b/docs/commands/lookahead-analysis.md index 84ea9c1d9..29d64940a 100644 --- a/docs/commands/lookahead-analysis.md +++ b/docs/commands/lookahead-analysis.md @@ -16,6 +16,7 @@ usage: freqtrade lookahead-analysis [-h] [-v] [--no-color] [--logfile FILE] [--strategy-list STRATEGY_LIST [STRATEGY_LIST ...]] [--export {none,trades,signals}] [--backtest-filename PATH] + [--export-directory PATH] [--freqai-backtest-live-models] [--minimum-trade-amount INT] [--targeted-trade-amount INT] @@ -62,7 +63,13 @@ options: Export backtest results (default: trades). --backtest-filename PATH, --export-filename PATH Use this filename for backtest results.Example: - `--backtest-filename=user_data/backtest_results/` + `--backtest- + filename=backtest_results_2020-09-27_16-20-48.json`. + Assumes either user_data/backtest_results/ or + `--export-directory` as base directory. + --export-directory PATH, --backtest-directory PATH + Directory to use for backtest results. Example: + `--export-directory=user_data/backtest_results/`. --freqai-backtest-live-models Run backtest with ready models. --minimum-trade-amount INT diff --git a/docs/commands/plot-dataframe.md b/docs/commands/plot-dataframe.md index 3179f8867..8fc066aab 100644 --- a/docs/commands/plot-dataframe.md +++ b/docs/commands/plot-dataframe.md @@ -40,7 +40,10 @@ options: Export backtest results (default: trades). --backtest-filename PATH, --export-filename PATH Use this filename for backtest results.Example: - `--backtest-filename=user_data/backtest_results/` + `--backtest- + filename=backtest_results_2020-09-27_16-20-48.json`. + Assumes either user_data/backtest_results/ or + `--export-directory` as base directory. --timerange TIMERANGE Specify what timerange of data to use. -i TIMEFRAME, --timeframe TIMEFRAME diff --git a/docs/commands/plot-profit.md b/docs/commands/plot-profit.md index 8bd970f2a..1579adbe1 100644 --- a/docs/commands/plot-profit.md +++ b/docs/commands/plot-profit.md @@ -21,7 +21,10 @@ options: Export backtest results (default: trades). --backtest-filename PATH, --export-filename PATH Use this filename for backtest results.Example: - `--backtest-filename=user_data/backtest_results/` + `--backtest- + filename=backtest_results_2020-09-27_16-20-48.json`. + Assumes either user_data/backtest_results/ or + `--export-directory` as base directory. --db-url PATH Override trades database URL, this is useful in custom deployments (default: `sqlite:///tradesv3.sqlite` for Live Run mode, `sqlite:///tradesv3.dryrun.sqlite` for