From bd1f8349775a6113197fb90fe92e405f4b2d3845 Mon Sep 17 00:00:00 2001 From: c9s Date: Wed, 4 Sep 2024 14:58:07 +0800 Subject: [PATCH] update command doc files --- doc/commands/bbgo.md | 2 +- doc/commands/bbgo_account.md | 2 +- doc/commands/bbgo_backtest.md | 2 +- 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 | 24 +++++++++++++----------- doc/commands/bbgo_get-order.md | 2 +- doc/commands/bbgo_hoptimize.md | 2 +- doc/commands/bbgo_kline.md | 2 +- doc/commands/bbgo_list-orders.md | 2 +- doc/commands/bbgo_margin.md | 2 +- doc/commands/bbgo_margin_interests.md | 2 +- doc/commands/bbgo_margin_loans.md | 2 +- doc/commands/bbgo_margin_repays.md | 2 +- doc/commands/bbgo_market.md | 2 +- doc/commands/bbgo_optimize.md | 2 +- 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 | 2 +- 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 +- 29 files changed, 41 insertions(+), 39 deletions(-) diff --git a/doc/commands/bbgo.md b/doc/commands/bbgo.md index a25bb54..9994e25 100644 --- a/doc/commands/bbgo.md +++ b/doc/commands/bbgo.md @@ -58,4 +58,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 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024 diff --git a/doc/commands/bbgo_account.md b/doc/commands/bbgo_account.md index 3997e25..cf9a9cd 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 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024 diff --git a/doc/commands/bbgo_backtest.md b/doc/commands/bbgo_backtest.md index f8cd4be..5bfe9d7 100644 --- a/doc/commands/bbgo_backtest.md +++ b/doc/commands/bbgo_backtest.md @@ -50,4 +50,4 @@ bbgo backtest [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024 diff --git a/doc/commands/bbgo_balances.md b/doc/commands/bbgo_balances.md index 45b8878..2402c45 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 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024 diff --git a/doc/commands/bbgo_build.md b/doc/commands/bbgo_build.md index 6157430..6c1ed39 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 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024 diff --git a/doc/commands/bbgo_cancel-order.md b/doc/commands/bbgo_cancel-order.md index 4f7c05e..44fdcde 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 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024 diff --git a/doc/commands/bbgo_deposits.md b/doc/commands/bbgo_deposits.md index fab6e69..6c40fda 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 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024 diff --git a/doc/commands/bbgo_execute-order.md b/doc/commands/bbgo_execute-order.md index 30f31f9..e06bc11 100644 --- a/doc/commands/bbgo_execute-order.md +++ b/doc/commands/bbgo_execute-order.md @@ -9,16 +9,18 @@ bbgo execute-order --session SESSION --symbol SYMBOL --side SIDE --target-quanti ### Options ``` - --deadline duration deadline of the order execution - -h, --help help for execute-order - --price-ticks int the number of price tick for the jump spread, default to 0 - --session string the exchange session name for sync - --side string the trading side: buy or sell - --slice-quantity string slice quantity - --stop-price string stop price (default "0") - --symbol string the trading pair, like btcusdt - --target-quantity string target quantity - --update-interval duration order update time (default 10s) + --deadline duration deadline duration of the order execution, e.g. 1h + --delay-interval duration order delay time after filled (default 3s) + -h, --help help for execute-order + --order-update-rate-limit string order update rate limit, syntax: 1+1/1m (default "1s") + --price-ticks int the number of price tick for the jump spread, default to 0 + --session string the exchange session name for sync + --side string the trading side: buy or sell + --slice-quantity string slice quantity + --stop-price string stop price (default "0") + --symbol string the trading pair, like btcusdt + --target-quantity string target quantity + --update-interval duration order update time (default 10s) ``` ### Options inherited from parent commands @@ -48,4 +50,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 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024 diff --git a/doc/commands/bbgo_get-order.md b/doc/commands/bbgo_get-order.md index 003f76e..614624f 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 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024 diff --git a/doc/commands/bbgo_hoptimize.md b/doc/commands/bbgo_hoptimize.md index 74f52a7..dc24d23 100644 --- a/doc/commands/bbgo_hoptimize.md +++ b/doc/commands/bbgo_hoptimize.md @@ -45,4 +45,4 @@ bbgo hoptimize [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024 diff --git a/doc/commands/bbgo_kline.md b/doc/commands/bbgo_kline.md index 66b503d..074938c 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 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024 diff --git a/doc/commands/bbgo_list-orders.md b/doc/commands/bbgo_list-orders.md index b88f336..3da55c0 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 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024 diff --git a/doc/commands/bbgo_margin.md b/doc/commands/bbgo_margin.md index b1150af..4e0dbc7 100644 --- a/doc/commands/bbgo_margin.md +++ b/doc/commands/bbgo_margin.md @@ -38,4 +38,4 @@ margin related 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 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024 diff --git a/doc/commands/bbgo_margin_interests.md b/doc/commands/bbgo_margin_interests.md index fe96c38..ac5db69 100644 --- a/doc/commands/bbgo_margin_interests.md +++ b/doc/commands/bbgo_margin_interests.md @@ -41,4 +41,4 @@ bbgo margin interests --session=SESSION_NAME --asset=ASSET [flags] * [bbgo margin](bbgo_margin.md) - margin related history -###### Auto generated by spf13/cobra on 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024 diff --git a/doc/commands/bbgo_margin_loans.md b/doc/commands/bbgo_margin_loans.md index 0701e08..0fb2628 100644 --- a/doc/commands/bbgo_margin_loans.md +++ b/doc/commands/bbgo_margin_loans.md @@ -41,4 +41,4 @@ bbgo margin loans --session=SESSION_NAME --asset=ASSET [flags] * [bbgo margin](bbgo_margin.md) - margin related history -###### Auto generated by spf13/cobra on 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024 diff --git a/doc/commands/bbgo_margin_repays.md b/doc/commands/bbgo_margin_repays.md index 194362c..15dda94 100644 --- a/doc/commands/bbgo_margin_repays.md +++ b/doc/commands/bbgo_margin_repays.md @@ -41,4 +41,4 @@ bbgo margin repays --session=SESSION_NAME --asset=ASSET [flags] * [bbgo margin](bbgo_margin.md) - margin related history -###### Auto generated by spf13/cobra on 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024 diff --git a/doc/commands/bbgo_market.md b/doc/commands/bbgo_market.md index b63ca70..f751277 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 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024 diff --git a/doc/commands/bbgo_optimize.md b/doc/commands/bbgo_optimize.md index 680ff16..e9fc119 100644 --- a/doc/commands/bbgo_optimize.md +++ b/doc/commands/bbgo_optimize.md @@ -44,4 +44,4 @@ bbgo optimize [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024 diff --git a/doc/commands/bbgo_orderbook.md b/doc/commands/bbgo_orderbook.md index 8e62870..672ab57 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 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024 diff --git a/doc/commands/bbgo_orderupdate.md b/doc/commands/bbgo_orderupdate.md index e0096af..3f8c66f 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 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024 diff --git a/doc/commands/bbgo_pnl.md b/doc/commands/bbgo_pnl.md index 49e8fdf..39c05cb 100644 --- a/doc/commands/bbgo_pnl.md +++ b/doc/commands/bbgo_pnl.md @@ -49,4 +49,4 @@ bbgo pnl [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024 diff --git a/doc/commands/bbgo_run.md b/doc/commands/bbgo_run.md index c0ff172..7158262 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 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024 diff --git a/doc/commands/bbgo_submit-order.md b/doc/commands/bbgo_submit-order.md index 77609e8..ff50eea 100644 --- a/doc/commands/bbgo_submit-order.md +++ b/doc/commands/bbgo_submit-order.md @@ -46,4 +46,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 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024 diff --git a/doc/commands/bbgo_sync.md b/doc/commands/bbgo_sync.md index f03b0d1..9d4653a 100644 --- a/doc/commands/bbgo_sync.md +++ b/doc/commands/bbgo_sync.md @@ -42,4 +42,4 @@ bbgo sync [--session=[exchange_name]] [--symbol=[pair_name]] [[--since=yyyy/mm/d * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024 diff --git a/doc/commands/bbgo_trades.md b/doc/commands/bbgo_trades.md index 1711b6c..e1cd63b 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 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024 diff --git a/doc/commands/bbgo_tradeupdate.md b/doc/commands/bbgo_tradeupdate.md index b354cd0..d60dd97 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 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024 diff --git a/doc/commands/bbgo_transfer-history.md b/doc/commands/bbgo_transfer-history.md index 2cd9f3a..fa528fd 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 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024 diff --git a/doc/commands/bbgo_userdatastream.md b/doc/commands/bbgo_userdatastream.md index 2639feb..86fc16f 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 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024 diff --git a/doc/commands/bbgo_version.md b/doc/commands/bbgo_version.md index 3c39960..d7dab46 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 21-Aug-2024 +###### Auto generated by spf13/cobra on 4-Sep-2024