From 53a29b1eaca0112df3447b88c3ab97c0629d3b3e Mon Sep 17 00:00:00 2001 From: c9s Date: Tue, 7 Jun 2022 22:24:47 +0800 Subject: [PATCH] update command doc files --- doc/commands/bbgo.md | 6 ++-- doc/commands/bbgo_account.md | 2 +- doc/commands/bbgo_backtest.md | 6 ++-- doc/commands/bbgo_balances.md | 2 +- doc/commands/bbgo_build.md | 2 +- doc/commands/bbgo_cancel-order.md | 2 +- doc/commands/bbgo_deposits.md | 2 +- doc/commands/bbgo_execute-order.md | 2 +- doc/commands/bbgo_get-order.md | 2 +- doc/commands/bbgo_kline.md | 2 +- doc/commands/bbgo_list-orders.md | 2 +- doc/commands/bbgo_margin.md | 41 ++++++++++++++++++++++++ doc/commands/bbgo_margin_interests.md | 44 ++++++++++++++++++++++++++ doc/commands/bbgo_margin_loans.md | 44 ++++++++++++++++++++++++++ doc/commands/bbgo_margin_repays.md | 44 ++++++++++++++++++++++++++ doc/commands/bbgo_market.md | 2 +- doc/commands/bbgo_optimize.md | 45 +++++++++++++++++++++++++++ doc/commands/bbgo_orderbook.md | 2 +- doc/commands/bbgo_orderupdate.md | 2 +- doc/commands/bbgo_pnl.md | 2 +- doc/commands/bbgo_run.md | 2 +- doc/commands/bbgo_submit-order.md | 2 +- doc/commands/bbgo_sync.md | 12 +++---- doc/commands/bbgo_trades.md | 2 +- doc/commands/bbgo_tradeupdate.md | 2 +- doc/commands/bbgo_transfer-history.md | 2 +- doc/commands/bbgo_userdatastream.md | 2 +- doc/commands/bbgo_version.md | 2 +- 28 files changed, 252 insertions(+), 30 deletions(-) create mode 100644 doc/commands/bbgo_margin.md create mode 100644 doc/commands/bbgo_margin_interests.md create mode 100644 doc/commands/bbgo_margin_loans.md create mode 100644 doc/commands/bbgo_margin_repays.md create mode 100644 doc/commands/bbgo_optimize.md diff --git a/doc/commands/bbgo.md b/doc/commands/bbgo.md index 79aed9b38..d9911cb1e 100644 --- a/doc/commands/bbgo.md +++ b/doc/commands/bbgo.md @@ -33,7 +33,7 @@ bbgo [flags] ### SEE ALSO * [bbgo account](bbgo_account.md) - show user account details (ex: balance) -* [bbgo backtest](bbgo_backtest.md) - backtest your strategies +* [bbgo backtest](bbgo_backtest.md) - run backtest with strategies * [bbgo balances](bbgo_balances.md) - Show user account balances * [bbgo build](bbgo_build.md) - build cross-platform binary * [bbgo cancel-order](bbgo_cancel-order.md) - cancel orders @@ -42,7 +42,9 @@ bbgo [flags] * [bbgo get-order](bbgo_get-order.md) - Get order status * [bbgo kline](bbgo_kline.md) - connect to the kline market data streaming service of an exchange * [bbgo list-orders](bbgo_list-orders.md) - list user's open orders in exchange of a specific trading pair +* [bbgo margin](bbgo_margin.md) - margin related history * [bbgo market](bbgo_market.md) - List the symbols that the are available to be traded in the exchange +* [bbgo optimize](bbgo_optimize.md) - run optimizer * [bbgo orderbook](bbgo_orderbook.md) - connect to the order book market data streaming service of an exchange * [bbgo orderupdate](bbgo_orderupdate.md) - Listen to order update events * [bbgo pnl](bbgo_pnl.md) - pnl calculator @@ -55,4 +57,4 @@ bbgo [flags] * [bbgo userdatastream](bbgo_userdatastream.md) - Listen to session events (orderUpdate, tradeUpdate, balanceUpdate, balanceSnapshot) * [bbgo version](bbgo_version.md) - show version name -###### Auto generated by spf13/cobra on 5-May-2022 +###### Auto generated by spf13/cobra on 7-Jun-2022 diff --git a/doc/commands/bbgo_account.md b/doc/commands/bbgo_account.md index c545c854e..74dc8f36f 100644 --- a/doc/commands/bbgo_account.md +++ b/doc/commands/bbgo_account.md @@ -41,4 +41,4 @@ bbgo account [--session SESSION] [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 5-May-2022 +###### Auto generated by spf13/cobra on 7-Jun-2022 diff --git a/doc/commands/bbgo_backtest.md b/doc/commands/bbgo_backtest.md index c80601f74..2b847854f 100644 --- a/doc/commands/bbgo_backtest.md +++ b/doc/commands/bbgo_backtest.md @@ -1,6 +1,6 @@ ## bbgo backtest -backtest your strategies +run backtest with strategies ``` bbgo backtest [flags] @@ -13,6 +13,8 @@ bbgo backtest [flags] --force force execution without confirm -h, --help help for backtest --output string the report output directory + --session string specify only one exchange session to run backtest + --subdir generate report in the sub-directory of the output directory --sync sync backtest data --sync-exchange string specify only one exchange to sync backtest data --sync-from string sync backtest data from the given time, which will override the time range in the backtest config @@ -48,4 +50,4 @@ bbgo backtest [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 5-May-2022 +###### Auto generated by spf13/cobra on 7-Jun-2022 diff --git a/doc/commands/bbgo_balances.md b/doc/commands/bbgo_balances.md index d7e346923..eeed2ae27 100644 --- a/doc/commands/bbgo_balances.md +++ b/doc/commands/bbgo_balances.md @@ -40,4 +40,4 @@ bbgo balances [--session SESSION] [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 5-May-2022 +###### Auto generated by spf13/cobra on 7-Jun-2022 diff --git a/doc/commands/bbgo_build.md b/doc/commands/bbgo_build.md index 8b653f8fa..740ca4716 100644 --- a/doc/commands/bbgo_build.md +++ b/doc/commands/bbgo_build.md @@ -39,4 +39,4 @@ bbgo build [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 5-May-2022 +###### Auto generated by spf13/cobra on 7-Jun-2022 diff --git a/doc/commands/bbgo_cancel-order.md b/doc/commands/bbgo_cancel-order.md index c97920bc1..4c9ab28c4 100644 --- a/doc/commands/bbgo_cancel-order.md +++ b/doc/commands/bbgo_cancel-order.md @@ -49,4 +49,4 @@ bbgo cancel-order [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 5-May-2022 +###### Auto generated by spf13/cobra on 7-Jun-2022 diff --git a/doc/commands/bbgo_deposits.md b/doc/commands/bbgo_deposits.md index dd6fddcd5..fc90e3a43 100644 --- a/doc/commands/bbgo_deposits.md +++ b/doc/commands/bbgo_deposits.md @@ -41,4 +41,4 @@ bbgo deposits [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 5-May-2022 +###### Auto generated by spf13/cobra on 7-Jun-2022 diff --git a/doc/commands/bbgo_execute-order.md b/doc/commands/bbgo_execute-order.md index df98cf1e8..acdc96681 100644 --- a/doc/commands/bbgo_execute-order.md +++ b/doc/commands/bbgo_execute-order.md @@ -48,4 +48,4 @@ bbgo execute-order --session SESSION --symbol SYMBOL --side SIDE --target-quanti * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 5-May-2022 +###### Auto generated by spf13/cobra on 7-Jun-2022 diff --git a/doc/commands/bbgo_get-order.md b/doc/commands/bbgo_get-order.md index 33499b5b8..503c2e625 100644 --- a/doc/commands/bbgo_get-order.md +++ b/doc/commands/bbgo_get-order.md @@ -42,4 +42,4 @@ bbgo get-order --session SESSION --order-id ORDER_ID [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 5-May-2022 +###### Auto generated by spf13/cobra on 7-Jun-2022 diff --git a/doc/commands/bbgo_kline.md b/doc/commands/bbgo_kline.md index 5cbcb4924..8db7e8aee 100644 --- a/doc/commands/bbgo_kline.md +++ b/doc/commands/bbgo_kline.md @@ -42,4 +42,4 @@ bbgo kline [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 5-May-2022 +###### Auto generated by spf13/cobra on 7-Jun-2022 diff --git a/doc/commands/bbgo_list-orders.md b/doc/commands/bbgo_list-orders.md index 075a22656..20650e30d 100644 --- a/doc/commands/bbgo_list-orders.md +++ b/doc/commands/bbgo_list-orders.md @@ -41,4 +41,4 @@ bbgo list-orders open|closed --session SESSION --symbol SYMBOL [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 5-May-2022 +###### Auto generated by spf13/cobra on 7-Jun-2022 diff --git a/doc/commands/bbgo_margin.md b/doc/commands/bbgo_margin.md new file mode 100644 index 000000000..67972869c --- /dev/null +++ b/doc/commands/bbgo_margin.md @@ -0,0 +1,41 @@ +## bbgo margin + +margin related history + +### Options + +``` + -h, --help help for margin +``` + +### Options inherited from parent commands + +``` + --binance-api-key string binance api key + --binance-api-secret string binance api secret + --config string config file (default "bbgo.yaml") + --debug debug mode + --dotenv string the dotenv file you want to load (default ".env.local") + --ftx-api-key string ftx api key + --ftx-api-secret string ftx api secret + --ftx-subaccount string subaccount name. Specify it if the credential is for subaccount. + --max-api-key string max api key + --max-api-secret string max api secret + --metrics enable prometheus metrics + --metrics-port string prometheus http server port (default "9090") + --no-dotenv disable built-in dotenv + --slack-channel string slack trading channel (default "dev-bbgo") + --slack-error-channel string slack error channel (default "bbgo-error") + --slack-token string slack token + --telegram-bot-auth-token string telegram auth token + --telegram-bot-token string telegram bot token from bot father +``` + +### SEE ALSO + +* [bbgo](bbgo.md) - bbgo is a crypto trading bot +* [bbgo margin interests](bbgo_margin_interests.md) - query interests history +* [bbgo margin loans](bbgo_margin_loans.md) - query loans history +* [bbgo margin repays](bbgo_margin_repays.md) - query repay history + +###### Auto generated by spf13/cobra on 7-Jun-2022 diff --git a/doc/commands/bbgo_margin_interests.md b/doc/commands/bbgo_margin_interests.md new file mode 100644 index 000000000..f4a99d628 --- /dev/null +++ b/doc/commands/bbgo_margin_interests.md @@ -0,0 +1,44 @@ +## bbgo margin interests + +query interests history + +``` +bbgo margin interests --session=SESSION_NAME --asset=ASSET [flags] +``` + +### Options + +``` + --asset string asset + -h, --help help for interests + --session string exchange session name +``` + +### Options inherited from parent commands + +``` + --binance-api-key string binance api key + --binance-api-secret string binance api secret + --config string config file (default "bbgo.yaml") + --debug debug mode + --dotenv string the dotenv file you want to load (default ".env.local") + --ftx-api-key string ftx api key + --ftx-api-secret string ftx api secret + --ftx-subaccount string subaccount name. Specify it if the credential is for subaccount. + --max-api-key string max api key + --max-api-secret string max api secret + --metrics enable prometheus metrics + --metrics-port string prometheus http server port (default "9090") + --no-dotenv disable built-in dotenv + --slack-channel string slack trading channel (default "dev-bbgo") + --slack-error-channel string slack error channel (default "bbgo-error") + --slack-token string slack token + --telegram-bot-auth-token string telegram auth token + --telegram-bot-token string telegram bot token from bot father +``` + +### SEE ALSO + +* [bbgo margin](bbgo_margin.md) - margin related history + +###### Auto generated by spf13/cobra on 7-Jun-2022 diff --git a/doc/commands/bbgo_margin_loans.md b/doc/commands/bbgo_margin_loans.md new file mode 100644 index 000000000..f2fdfcd65 --- /dev/null +++ b/doc/commands/bbgo_margin_loans.md @@ -0,0 +1,44 @@ +## bbgo margin loans + +query loans history + +``` +bbgo margin loans --session=SESSION_NAME --asset=ASSET [flags] +``` + +### Options + +``` + --asset string asset + -h, --help help for loans + --session string exchange session name +``` + +### Options inherited from parent commands + +``` + --binance-api-key string binance api key + --binance-api-secret string binance api secret + --config string config file (default "bbgo.yaml") + --debug debug mode + --dotenv string the dotenv file you want to load (default ".env.local") + --ftx-api-key string ftx api key + --ftx-api-secret string ftx api secret + --ftx-subaccount string subaccount name. Specify it if the credential is for subaccount. + --max-api-key string max api key + --max-api-secret string max api secret + --metrics enable prometheus metrics + --metrics-port string prometheus http server port (default "9090") + --no-dotenv disable built-in dotenv + --slack-channel string slack trading channel (default "dev-bbgo") + --slack-error-channel string slack error channel (default "bbgo-error") + --slack-token string slack token + --telegram-bot-auth-token string telegram auth token + --telegram-bot-token string telegram bot token from bot father +``` + +### SEE ALSO + +* [bbgo margin](bbgo_margin.md) - margin related history + +###### Auto generated by spf13/cobra on 7-Jun-2022 diff --git a/doc/commands/bbgo_margin_repays.md b/doc/commands/bbgo_margin_repays.md new file mode 100644 index 000000000..82863601b --- /dev/null +++ b/doc/commands/bbgo_margin_repays.md @@ -0,0 +1,44 @@ +## bbgo margin repays + +query repay history + +``` +bbgo margin repays --session=SESSION_NAME --asset=ASSET [flags] +``` + +### Options + +``` + --asset string asset + -h, --help help for repays + --session string exchange session name +``` + +### Options inherited from parent commands + +``` + --binance-api-key string binance api key + --binance-api-secret string binance api secret + --config string config file (default "bbgo.yaml") + --debug debug mode + --dotenv string the dotenv file you want to load (default ".env.local") + --ftx-api-key string ftx api key + --ftx-api-secret string ftx api secret + --ftx-subaccount string subaccount name. Specify it if the credential is for subaccount. + --max-api-key string max api key + --max-api-secret string max api secret + --metrics enable prometheus metrics + --metrics-port string prometheus http server port (default "9090") + --no-dotenv disable built-in dotenv + --slack-channel string slack trading channel (default "dev-bbgo") + --slack-error-channel string slack error channel (default "bbgo-error") + --slack-token string slack token + --telegram-bot-auth-token string telegram auth token + --telegram-bot-token string telegram bot token from bot father +``` + +### SEE ALSO + +* [bbgo margin](bbgo_margin.md) - margin related history + +###### Auto generated by spf13/cobra on 7-Jun-2022 diff --git a/doc/commands/bbgo_market.md b/doc/commands/bbgo_market.md index 456575252..bbc3d652a 100644 --- a/doc/commands/bbgo_market.md +++ b/doc/commands/bbgo_market.md @@ -40,4 +40,4 @@ bbgo market [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 5-May-2022 +###### Auto generated by spf13/cobra on 7-Jun-2022 diff --git a/doc/commands/bbgo_optimize.md b/doc/commands/bbgo_optimize.md new file mode 100644 index 000000000..857390719 --- /dev/null +++ b/doc/commands/bbgo_optimize.md @@ -0,0 +1,45 @@ +## bbgo optimize + +run optimizer + +``` +bbgo optimize [flags] +``` + +### Options + +``` + -h, --help help for optimize + --json print optimizer metrics in json format + --optimizer-config string config file (default "optimizer.yaml") + --output string backtest report output directory (default "output") +``` + +### Options inherited from parent commands + +``` + --binance-api-key string binance api key + --binance-api-secret string binance api secret + --config string config file (default "bbgo.yaml") + --debug debug mode + --dotenv string the dotenv file you want to load (default ".env.local") + --ftx-api-key string ftx api key + --ftx-api-secret string ftx api secret + --ftx-subaccount string subaccount name. Specify it if the credential is for subaccount. + --max-api-key string max api key + --max-api-secret string max api secret + --metrics enable prometheus metrics + --metrics-port string prometheus http server port (default "9090") + --no-dotenv disable built-in dotenv + --slack-channel string slack trading channel (default "dev-bbgo") + --slack-error-channel string slack error channel (default "bbgo-error") + --slack-token string slack token + --telegram-bot-auth-token string telegram auth token + --telegram-bot-token string telegram bot token from bot father +``` + +### SEE ALSO + +* [bbgo](bbgo.md) - bbgo is a crypto trading bot + +###### Auto generated by spf13/cobra on 7-Jun-2022 diff --git a/doc/commands/bbgo_orderbook.md b/doc/commands/bbgo_orderbook.md index 688fa7aba..591be099f 100644 --- a/doc/commands/bbgo_orderbook.md +++ b/doc/commands/bbgo_orderbook.md @@ -42,4 +42,4 @@ bbgo orderbook --session=[exchange_name] --symbol=[pair_name] [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 5-May-2022 +###### Auto generated by spf13/cobra on 7-Jun-2022 diff --git a/doc/commands/bbgo_orderupdate.md b/doc/commands/bbgo_orderupdate.md index ca0550a0c..7afdc1144 100644 --- a/doc/commands/bbgo_orderupdate.md +++ b/doc/commands/bbgo_orderupdate.md @@ -40,4 +40,4 @@ bbgo orderupdate [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 5-May-2022 +###### Auto generated by spf13/cobra on 7-Jun-2022 diff --git a/doc/commands/bbgo_pnl.md b/doc/commands/bbgo_pnl.md index 00ed296fb..3e73d4d5d 100644 --- a/doc/commands/bbgo_pnl.md +++ b/doc/commands/bbgo_pnl.md @@ -43,4 +43,4 @@ bbgo pnl [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 5-May-2022 +###### Auto generated by spf13/cobra on 7-Jun-2022 diff --git a/doc/commands/bbgo_run.md b/doc/commands/bbgo_run.md index ea3760fd2..9f59babf3 100644 --- a/doc/commands/bbgo_run.md +++ b/doc/commands/bbgo_run.md @@ -51,4 +51,4 @@ bbgo run [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 5-May-2022 +###### Auto generated by spf13/cobra on 7-Jun-2022 diff --git a/doc/commands/bbgo_submit-order.md b/doc/commands/bbgo_submit-order.md index 9352dc71e..be25db71e 100644 --- a/doc/commands/bbgo_submit-order.md +++ b/doc/commands/bbgo_submit-order.md @@ -44,4 +44,4 @@ bbgo submit-order --session SESSION --symbol SYMBOL --side SIDE --quantity QUANT * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 5-May-2022 +###### Auto generated by spf13/cobra on 7-Jun-2022 diff --git a/doc/commands/bbgo_sync.md b/doc/commands/bbgo_sync.md index 95c06e9c7..77abcd023 100644 --- a/doc/commands/bbgo_sync.md +++ b/doc/commands/bbgo_sync.md @@ -3,16 +3,16 @@ sync trades and orders history ``` -bbgo sync --session=[exchange_name] --symbol=[pair_name] [--since=yyyy/mm/dd] [flags] +bbgo sync [--session=[exchange_name]] [--symbol=[pair_name]] [[--since=yyyy/mm/dd]] [flags] ``` ### Options ``` - -h, --help help for sync - --session string the exchange session name for sync - --since string sync from time - --symbol string symbol of market for syncing + -h, --help help for sync + --session stringArray the exchange session name for sync + --since string sync from time + --symbol string symbol of market for syncing ``` ### Options inherited from parent commands @@ -42,4 +42,4 @@ bbgo sync --session=[exchange_name] --symbol=[pair_name] [--since=yyyy/mm/dd] [f * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 5-May-2022 +###### Auto generated by spf13/cobra on 7-Jun-2022 diff --git a/doc/commands/bbgo_trades.md b/doc/commands/bbgo_trades.md index c4f6d62fb..a3236182f 100644 --- a/doc/commands/bbgo_trades.md +++ b/doc/commands/bbgo_trades.md @@ -42,4 +42,4 @@ bbgo trades --session=[exchange_name] --symbol=[pair_name] [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 5-May-2022 +###### Auto generated by spf13/cobra on 7-Jun-2022 diff --git a/doc/commands/bbgo_tradeupdate.md b/doc/commands/bbgo_tradeupdate.md index f4055475e..cd9465bd0 100644 --- a/doc/commands/bbgo_tradeupdate.md +++ b/doc/commands/bbgo_tradeupdate.md @@ -40,4 +40,4 @@ bbgo tradeupdate --session=[exchange_name] [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 5-May-2022 +###### Auto generated by spf13/cobra on 7-Jun-2022 diff --git a/doc/commands/bbgo_transfer-history.md b/doc/commands/bbgo_transfer-history.md index d9274be0e..4a673267b 100644 --- a/doc/commands/bbgo_transfer-history.md +++ b/doc/commands/bbgo_transfer-history.md @@ -42,4 +42,4 @@ bbgo transfer-history [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 5-May-2022 +###### Auto generated by spf13/cobra on 7-Jun-2022 diff --git a/doc/commands/bbgo_userdatastream.md b/doc/commands/bbgo_userdatastream.md index 0657de234..54b6a1956 100644 --- a/doc/commands/bbgo_userdatastream.md +++ b/doc/commands/bbgo_userdatastream.md @@ -40,4 +40,4 @@ bbgo userdatastream [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 5-May-2022 +###### Auto generated by spf13/cobra on 7-Jun-2022 diff --git a/doc/commands/bbgo_version.md b/doc/commands/bbgo_version.md index 44d6d9e3d..9103b7313 100644 --- a/doc/commands/bbgo_version.md +++ b/doc/commands/bbgo_version.md @@ -39,4 +39,4 @@ bbgo version [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 5-May-2022 +###### Auto generated by spf13/cobra on 7-Jun-2022