Deployed 706955e to develop in en with MkDocs 1.6.1 and mike 2.1.3

This commit is contained in:
github-actions[bot]
2025-11-09 08:03:02 +00:00
parent 606450699c
commit 2b948be840
10 changed files with 1525 additions and 1522 deletions

View File

@@ -1865,110 +1865,107 @@
<p>The clock on the system running the bot must be accurate, synchronized to a NTP server frequently enough to avoid problems with communication to the exchanges.</p>
</div>
<h2 id="bot-commands">Bot commands<a class="headerlink" href="#bot-commands" title="Permanent link">&para;</a></h2>
<div class="highlight"><pre><span></span><code>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}
...
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade [-h] [-V]</span>
<span class="go"> {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} ...</span>
Free, open source crypto trading bot
<span class="go">Free, open source crypto trading bot</span>
positional arguments:
{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 Trade module.
create-userdir Create user-data directory.
new-config Create new config
show-config Show resolved config
new-strategy Create new strategy
download-data Download backtesting data.
convert-data Convert candle (OHLCV) data from one format to
another.
convert-trade-data Convert trade data from one format to another.
trades-to-ohlcv Convert trade data to OHLCV data.
list-data List downloaded data.
backtesting Backtesting module.
backtesting-show Show past Backtest results
backtesting-analysis
Backtest Analysis module.
edge Edge module. No longer part of Freqtrade
hyperopt Hyperopt module.
hyperopt-list List Hyperopt results
hyperopt-show Show details of Hyperopt results
list-exchanges Print available exchanges.
list-markets Print markets on exchange.
list-pairs Print pairs on exchange.
list-strategies Print available strategies.
list-hyperoptloss Print available hyperopt loss functions.
list-freqaimodels Print available freqAI models.
list-timeframes Print available timeframes for the exchange.
show-trades Show trades.
test-pairlist Test your pairlist configuration.
convert-db Migrate database to different system
install-ui Install FreqUI
plot-dataframe Plot candles with indicators.
plot-profit Generate plot showing profits.
webserver Webserver module.
strategy-updater updates outdated strategy files to the current version
lookahead-analysis Check for potential look ahead bias.
recursive-analysis Check for potential recursive formula issue.
<span class="go">positional arguments:</span>
<span class="go"> {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}</span>
<span class="go"> trade Trade module.</span>
<span class="go"> create-userdir Create user-data directory.</span>
<span class="go"> new-config Create new config</span>
<span class="go"> show-config Show resolved config</span>
<span class="go"> new-strategy Create new strategy</span>
<span class="go"> download-data Download backtesting data.</span>
<span class="go"> convert-data Convert candle (OHLCV) data from one format to</span>
<span class="go"> another.</span>
<span class="go"> convert-trade-data Convert trade data from one format to another.</span>
<span class="go"> trades-to-ohlcv Convert trade data to OHLCV data.</span>
<span class="go"> list-data List downloaded data.</span>
<span class="go"> backtesting Backtesting module.</span>
<span class="go"> backtesting-show Show past Backtest results</span>
<span class="go"> backtesting-analysis</span>
<span class="go"> Backtest Analysis module.</span>
<span class="go"> edge Edge module. No longer part of Freqtrade</span>
<span class="go"> hyperopt Hyperopt module.</span>
<span class="go"> hyperopt-list List Hyperopt results</span>
<span class="go"> hyperopt-show Show details of Hyperopt results</span>
<span class="go"> list-exchanges Print available exchanges.</span>
<span class="go"> list-markets Print markets on exchange.</span>
<span class="go"> list-pairs Print pairs on exchange.</span>
<span class="go"> list-strategies Print available strategies.</span>
<span class="go"> list-hyperoptloss Print available hyperopt loss functions.</span>
<span class="go"> list-freqaimodels Print available freqAI models.</span>
<span class="go"> list-timeframes Print available timeframes for the exchange.</span>
<span class="go"> show-trades Show trades.</span>
<span class="go"> test-pairlist Test your pairlist configuration.</span>
<span class="go"> convert-db Migrate database to different system</span>
<span class="go"> install-ui Install FreqUI</span>
<span class="go"> plot-dataframe Plot candles with indicators.</span>
<span class="go"> plot-profit Generate plot showing profits.</span>
<span class="go"> webserver Webserver module.</span>
<span class="go"> strategy-updater updates outdated strategy files to the current version</span>
<span class="go"> lookahead-analysis Check for potential look ahead bias.</span>
<span class="go"> recursive-analysis Check for potential recursive formula issue.</span>
options:
-h, --help show this help message and exit
-V, --version show program&#39;s version number and exit
<span class="go">options:</span>
<span class="go"> -h, --help show this help message and exit</span>
<span class="go"> -V, --version show program&#39;s version number and exit</span>
</code></pre></div>
<h3 id="bot-trading-commands">Bot trading commands<a class="headerlink" href="#bot-trading-commands" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code>usage: freqtrade trade [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH]
[-d PATH] [--userdir PATH] [-s NAME]
[--strategy-path PATH] [--recursive-strategy-search]
[--freqaimodel NAME] [--freqaimodel-path PATH]
[--db-url PATH] [--sd-notify] [--dry-run]
[--dry-run-wallet DRY_RUN_WALLET] [--fee FLOAT]
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade trade [-h] [-v] [--no-color] [--logfile FILE] [-V] [-c PATH]</span>
<span class="go"> [-d PATH] [--userdir PATH] [-s NAME]</span>
<span class="go"> [--strategy-path PATH] [--recursive-strategy-search]</span>
<span class="go"> [--freqaimodel NAME] [--freqaimodel-path PATH]</span>
<span class="go"> [--db-url PATH] [--sd-notify] [--dry-run]</span>
<span class="go"> [--dry-run-wallet DRY_RUN_WALLET] [--fee FLOAT]</span>
options:
-h, --help show this help message and exit
--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
Dry Run).
--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
Starting balance, used for backtesting / hyperopt and
dry-runs.
--fee FLOAT Specify fee ratio. Will be applied twice (on trade
entry and exit).
<span class="go">options:</span>
<span class="go"> -h, --help show this help message and exit</span>
<span class="go"> --db-url PATH Override trades database URL, this is useful in custom</span>
<span class="go"> deployments (default: `sqlite:///tradesv3.sqlite` for</span>
<span class="go"> Live Run mode, `sqlite:///tradesv3.dryrun.sqlite` for</span>
<span class="go"> Dry Run).</span>
<span class="go"> --sd-notify Notify systemd service manager.</span>
<span class="go"> --dry-run Enforce dry-run for trading (removes Exchange secrets</span>
<span class="go"> and simulates trades).</span>
<span class="go"> --dry-run-wallet, --starting-balance DRY_RUN_WALLET</span>
<span class="go"> Starting balance, used for backtesting / hyperopt and</span>
<span class="go"> dry-runs.</span>
<span class="go"> --fee FLOAT Specify fee ratio. Will be applied twice (on trade</span>
<span class="go"> entry and exit).</span>
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
Log to the file specified. Special values are:
&#39;syslog&#39;, &#39;journald&#39;. See the documentation for more
details.
-V, --version show program&#39;s version number 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.
-d PATH, --datadir PATH, --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
Path to userdata directory.
<span class="go">Common arguments:</span>
<span class="go"> -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).</span>
<span class="go"> --no-color Disable colorization of hyperopt results. May be</span>
<span class="go"> useful if you are redirecting output to a file.</span>
<span class="go"> --logfile, --log-file FILE</span>
<span class="go"> Log to the file specified. Special values are:</span>
<span class="go"> &#39;syslog&#39;, &#39;journald&#39;. See the documentation for more</span>
<span class="go"> details.</span>
<span class="go"> -V, --version show program&#39;s version number and exit</span>
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
<span class="go"> exists). Multiple --config options may be used. Can be</span>
<span class="go"> set to `-` to read config from stdin.</span>
<span class="go"> -d, --datadir, --data-dir PATH</span>
<span class="go"> Path to the base directory of the exchange with</span>
<span class="go"> historical backtesting data. To see futures data, use</span>
<span class="go"> trading-mode additionally.</span>
<span class="go"> --userdir, --user-data-dir PATH</span>
<span class="go"> Path to userdata directory.</span>
Strategy arguments:
-s NAME, --strategy NAME
Specify strategy class name which will be used by the
bot.
--strategy-path PATH Specify additional strategy lookup path.
--recursive-strategy-search
Recursively search for a strategy in the strategies
folder.
--freqaimodel NAME Specify a custom freqaimodels.
--freqaimodel-path PATH
Specify additional lookup path for freqaimodels.
<span class="go">Strategy arguments:</span>
<span class="go"> -s, --strategy NAME Specify strategy class name which will be used by the</span>
<span class="go"> bot.</span>
<span class="go"> --strategy-path PATH Specify additional strategy lookup path.</span>
<span class="go"> --recursive-strategy-search</span>
<span class="go"> Recursively search for a strategy in the strategies</span>
<span class="go"> folder.</span>
<span class="go"> --freqaimodel NAME Specify a custom freqaimodels.</span>
<span class="go"> --freqaimodel-path PATH</span>
<span class="go"> Specify additional lookup path for freqaimodels.</span>
</code></pre></div>
<h3 id="how-to-specify-which-configuration-file-be-used">How to specify which configuration file be used?<a class="headerlink" href="#how-to-specify-which-configuration-file-be-used" title="Permanent link">&para;</a></h3>
<p>The bot allows you to select which configuration file you want to use by means of