Skip to content

Commit d064bd4

Browse files
xmatthiasxmatthias
committed
chore: prefer --backtest-filename over --export-filename!
1 parent 765d2c3 commit d064bd4

File tree

7 files changed

+27
-33
lines changed

7 files changed

+27
-33
lines changed

‎docs/commands/backtesting-analysis.md‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
usage: freqtrade backtesting-analysis [-h] [-v] [--no-color] [--logfile FILE]
33
[-V] [-c PATH] [-d PATH]
44
[--userdir PATH]
5-
[--export-filename PATH]
5+
[--backtest-filename PATH]
66
[--analysis-groups {0,1,2,3,4,5} [{0,1,2,3,4,5} ...]]
77
[--enter-reason-list ENTER_REASON_LIST [ENTER_REASON_LIST ...]]
88
[--exit-reason-list EXIT_REASON_LIST [EXIT_REASON_LIST ...]]
@@ -14,10 +14,9 @@ usage: freqtrade backtesting-analysis [-h] [-v] [--no-color] [--logfile FILE]
1414
1515
options:
1616
-h, --help show this help message and exit
17-
--export-filename PATH, --backtest-filename PATH
18-
Use this filename for backtest results.Requires
19-
`--export` to be set as well. Example: `--export-filen
20-
ame=user_data/backtest_results/backtest_today.json`
17+
--backtest-filename PATH, --export-filename PATH
18+
Use this filename for backtest results.Example:
19+
`--backtest-filename=user_data/backtest_results/`
2120
--analysis-groups {0,1,2,3,4,5} [{0,1,2,3,4,5} ...]
2221
grouping output - 0: simple wins/losses by enter tag,
2322
1: by enter_tag, 2: by enter_tag and exit_tag, 3: by

‎docs/commands/backtesting-show.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
```
22
usage: freqtrade backtesting-show [-h] [-v] [--no-color] [--logfile FILE] [-V]
33
[-c PATH] [-d PATH] [--userdir PATH]
4-
[--export-filename PATH] [--show-pair-list]
4+
[--backtest-filename PATH]
5+
[--show-pair-list]
56
[--breakdown {day,week,month,year} [{day,week,month,year} ...]]
67
78
options:
89
-h, --help show this help message and exit
9-
--export-filename PATH, --backtest-filename PATH
10-
Use this filename for backtest results.Requires
11-
`--export` to be set as well. Example: `--export-filen
12-
ame=user_data/backtest_results/backtest_today.json`
10+
--backtest-filename PATH, --export-filename PATH
11+
Use this filename for backtest results.Example:
12+
`--backtest-filename=user_data/backtest_results/`
1313
--show-pair-list Show backtesting pairlist sorted by profit.
1414
--breakdown {day,week,month,year} [{day,week,month,year} ...]
1515
Show backtesting breakdown per [day, week, month,

‎docs/commands/backtesting.md‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ usage: freqtrade backtesting [-h] [-v] [--no-color] [--logfile FILE] [-V]
1414
[--timeframe-detail TIMEFRAME_DETAIL]
1515
[--strategy-list STRATEGY_LIST [STRATEGY_LIST ...]]
1616
[--export {none,trades,signals}]
17-
[--export-filename PATH]
17+
[--backtest-filename PATH]
1818
[--breakdown {day,week,month,year} [{day,week,month,year} ...]]
1919
[--cache {none,day,week,month}]
2020
[--freqai-backtest-live-models] [--notes TEXT]
@@ -61,10 +61,9 @@ options:
6161
becomes `backtest-data-SampleStrategy.json`
6262
--export {none,trades,signals}
6363
Export backtest results (default: trades).
64-
--export-filename PATH, --backtest-filename PATH
65-
Use this filename for backtest results.Requires
66-
`--export` to be set as well. Example: `--export-filen
67-
ame=user_data/backtest_results/backtest_today.json`
64+
--backtest-filename PATH, --export-filename PATH
65+
Use this filename for backtest results.Example:
66+
`--backtest-filename=user_data/backtest_results/`
6867
--breakdown {day,week,month,year} [{day,week,month,year} ...]
6968
Show backtesting breakdown per [day, week, month,
7069
year].

‎docs/commands/lookahead-analysis.md‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ usage: freqtrade lookahead-analysis [-h] [-v] [--no-color] [--logfile FILE]
1515
[--timeframe-detail TIMEFRAME_DETAIL]
1616
[--strategy-list STRATEGY_LIST [STRATEGY_LIST ...]]
1717
[--export {none,trades,signals}]
18-
[--export-filename PATH]
18+
[--backtest-filename PATH]
1919
[--freqai-backtest-live-models]
2020
[--minimum-trade-amount INT]
2121
[--targeted-trade-amount INT]
@@ -60,10 +60,9 @@ options:
6060
becomes `backtest-data-SampleStrategy.json`
6161
--export {none,trades,signals}
6262
Export backtest results (default: trades).
63-
--export-filename PATH, --backtest-filename PATH
64-
Use this filename for backtest results.Requires
65-
`--export` to be set as well. Example: `--export-filen
66-
ame=user_data/backtest_results/backtest_today.json`
63+
--backtest-filename PATH, --export-filename PATH
64+
Use this filename for backtest results.Example:
65+
`--backtest-filename=user_data/backtest_results/`
6766
--freqai-backtest-live-models
6867
Run backtest with ready models.
6968
--minimum-trade-amount INT

‎docs/commands/plot-dataframe.md‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ usage: freqtrade plot-dataframe [-h] [-v] [--no-color] [--logfile FILE] [-V]
1010
[--plot-limit INT] [--db-url PATH]
1111
[--trade-source {DB,file}]
1212
[--export {none,trades,signals}]
13-
[--export-filename PATH]
13+
[--backtest-filename PATH]
1414
[--timerange TIMERANGE] [-i TIMEFRAME]
1515
[--no-trades]
1616
@@ -38,10 +38,9 @@ options:
3838
(backtest file)) Default: file
3939
--export {none,trades,signals}
4040
Export backtest results (default: trades).
41-
--export-filename PATH, --backtest-filename PATH
42-
Use this filename for backtest results.Requires
43-
`--export` to be set as well. Example: `--export-filen
44-
ame=user_data/backtest_results/backtest_today.json`
41+
--backtest-filename PATH, --export-filename PATH
42+
Use this filename for backtest results.Example:
43+
`--backtest-filename=user_data/backtest_results/`
4544
--timerange TIMERANGE
4645
Specify what timerange of data to use.
4746
-i TIMEFRAME, --timeframe TIMEFRAME

‎docs/commands/plot-profit.md‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ usage: freqtrade plot-profit [-h] [-v] [--no-color] [--logfile FILE] [-V]
66
[--freqaimodel NAME] [--freqaimodel-path PATH]
77
[-p PAIRS [PAIRS ...]] [--timerange TIMERANGE]
88
[--export {none,trades,signals}]
9-
[--export-filename PATH] [--db-url PATH]
9+
[--backtest-filename PATH] [--db-url PATH]
1010
[--trade-source {DB,file}] [-i TIMEFRAME]
1111
[--auto-open]
1212
@@ -19,10 +19,9 @@ options:
1919
Specify what timerange of data to use.
2020
--export {none,trades,signals}
2121
Export backtest results (default: trades).
22-
--export-filename PATH, --backtest-filename PATH
23-
Use this filename for backtest results.Requires
24-
`--export` to be set as well. Example: `--export-filen
25-
ame=user_data/backtest_results/backtest_today.json`
22+
--backtest-filename PATH, --export-filename PATH
23+
Use this filename for backtest results.Example:
24+
`--backtest-filename=user_data/backtest_results/`
2625
--db-url PATH Override trades database URL, this is useful in custom
2726
deployments (default: `sqlite:///tradesv3.sqlite` for
2827
Live Run mode, `sqlite:///tradesv3.dryrun.sqlite` for

‎freqtrade/commands/cli_options.py‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -210,11 +210,10 @@ def __init__(self, *args, **kwargs):
210210
metavar="TEXT",
211211
),
212212
"exportfilename": Arg(
213-
"--export-filename",
214213
"--backtest-filename",
214+
"--export-filename",
215215
help="Use this filename for backtest results."
216-
"Requires `--export` to be set as well. "
217-
"Example: `--export-filename=user_data/backtest_results/backtest_today.json`",
216+
"Example: `--backtest-filename=user_data/backtest_results/`",
218217
metavar="PATH",
219218
),
220219
"disableparamexport": Arg(

0 commit comments

Comments
 (0)