diff --git a/docs/bot-usage.md b/docs/bot-usage.md index dfc1ef86a..593a36500 100644 --- a/docs/bot-usage.md +++ b/docs/bot-usage.md @@ -10,56 +10,7 @@ This page explains the different parameters of the bot and how to run it. ## Bot commands -``` -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-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 - -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-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. - 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-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. - -options: - -h, --help show this help message and exit - -V, --version show program's version number and exit - -``` +--8<-- "commands/main.md" ### Bot trading commands diff --git a/docs/commands/main.md b/docs/commands/main.md new file mode 100644 index 000000000..c84f4854e --- /dev/null +++ b/docs/commands/main.md @@ -0,0 +1,51 @@ +``` +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} + ... + +Free, open source crypto trading bot + +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. + 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. + +options: + -h, --help show this help message and exit + -V, --version show program's version number and exit + +```