From 80bded18378aba0e1c36ba8b16939c52bc450940 Mon Sep 17 00:00:00 2001 From: c9s Date: Tue, 14 May 2024 15:08:21 +0800 Subject: [PATCH] update command doc files --- doc/commands/bbgo.md | 2 +- doc/commands/bbgo_account.md | 2 +- doc/commands/bbgo_backtest.md | 4 ++-- doc/commands/bbgo_balances.md | 2 +- doc/commands/bbgo_build.md | 6 +++--- 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_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, 32 insertions(+), 32 deletions(-) diff --git a/doc/commands/bbgo.md b/doc/commands/bbgo.md index ee9b38a40..9921fc661 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 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024 diff --git a/doc/commands/bbgo_account.md b/doc/commands/bbgo_account.md index f51b4d9de..1271794ba 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 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024 diff --git a/doc/commands/bbgo_backtest.md b/doc/commands/bbgo_backtest.md index 451d33de6..b9eb7a3b6 100644 --- a/doc/commands/bbgo_backtest.md +++ b/doc/commands/bbgo_backtest.md @@ -10,7 +10,6 @@ bbgo backtest [flags] ``` --base-asset-baseline use base asset performance as the competitive baseline performance - --config string strategy config file (default "config/bbgo.yaml") --force force execution without confirm -h, --help help for backtest --output string the report output directory @@ -29,6 +28,7 @@ bbgo backtest [flags] ``` --binance-api-key string binance api key --binance-api-secret string binance api secret + --config string config file (default "bbgo.yaml") --cpu-profile string cpu profile --debug debug mode --dotenv string the dotenv file you want to load (default ".env.local") @@ -50,4 +50,4 @@ bbgo backtest [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024 diff --git a/doc/commands/bbgo_balances.md b/doc/commands/bbgo_balances.md index fa43751ea..c7c92ff02 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 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024 diff --git a/doc/commands/bbgo_build.md b/doc/commands/bbgo_build.md index c49ca5b96..cd617d93b 100644 --- a/doc/commands/bbgo_build.md +++ b/doc/commands/bbgo_build.md @@ -9,8 +9,7 @@ bbgo build [flags] ### Options ``` - --config string config file (default "bbgo.yaml") - -h, --help help for build + -h, --help help for build ``` ### Options inherited from parent commands @@ -18,6 +17,7 @@ bbgo build [flags] ``` --binance-api-key string binance api key --binance-api-secret string binance api secret + --config string config file (default "bbgo.yaml") --cpu-profile string cpu profile --debug debug mode --dotenv string the dotenv file you want to load (default ".env.local") @@ -39,4 +39,4 @@ bbgo build [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024 diff --git a/doc/commands/bbgo_cancel-order.md b/doc/commands/bbgo_cancel-order.md index 5318f4a4f..758ff1665 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 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024 diff --git a/doc/commands/bbgo_deposits.md b/doc/commands/bbgo_deposits.md index 1acf43256..913aeb6a4 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 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024 diff --git a/doc/commands/bbgo_execute-order.md b/doc/commands/bbgo_execute-order.md index a885c5835..f4775cb85 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 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024 diff --git a/doc/commands/bbgo_get-order.md b/doc/commands/bbgo_get-order.md index 5959ac84c..15c127c48 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 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024 diff --git a/doc/commands/bbgo_hoptimize.md b/doc/commands/bbgo_hoptimize.md index 6a104f0ed..8031b0d9a 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 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024 diff --git a/doc/commands/bbgo_kline.md b/doc/commands/bbgo_kline.md index 1748fadc6..61ea2f5c7 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 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024 diff --git a/doc/commands/bbgo_list-orders.md b/doc/commands/bbgo_list-orders.md index feb9854ac..4e0c387fc 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 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024 diff --git a/doc/commands/bbgo_margin.md b/doc/commands/bbgo_margin.md index 4a3f588ca..798611c85 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 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024 diff --git a/doc/commands/bbgo_margin_interests.md b/doc/commands/bbgo_margin_interests.md index 006869938..bdc1d58d4 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 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024 diff --git a/doc/commands/bbgo_margin_loans.md b/doc/commands/bbgo_margin_loans.md index b32bad062..7416b3c6e 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 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024 diff --git a/doc/commands/bbgo_margin_repays.md b/doc/commands/bbgo_margin_repays.md index f5a04acca..4c854c17c 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 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024 diff --git a/doc/commands/bbgo_market.md b/doc/commands/bbgo_market.md index a86a44f57..e165ce83f 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 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024 diff --git a/doc/commands/bbgo_optimize.md b/doc/commands/bbgo_optimize.md index 17d1a07b1..eb0a84206 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 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024 diff --git a/doc/commands/bbgo_orderbook.md b/doc/commands/bbgo_orderbook.md index cfa6bb860..857575da6 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 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024 diff --git a/doc/commands/bbgo_orderupdate.md b/doc/commands/bbgo_orderupdate.md index 14df25e77..f179d623f 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 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024 diff --git a/doc/commands/bbgo_pnl.md b/doc/commands/bbgo_pnl.md index 1dd9917d2..b0accb7bf 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 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024 diff --git a/doc/commands/bbgo_run.md b/doc/commands/bbgo_run.md index 3d7c91402..c098f4bbb 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 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024 diff --git a/doc/commands/bbgo_submit-order.md b/doc/commands/bbgo_submit-order.md index 39cafff71..c53367e12 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 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024 diff --git a/doc/commands/bbgo_sync.md b/doc/commands/bbgo_sync.md index 72a5b928a..cc7bcccd1 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 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024 diff --git a/doc/commands/bbgo_trades.md b/doc/commands/bbgo_trades.md index fdbdd8ff7..214411cd5 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 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024 diff --git a/doc/commands/bbgo_tradeupdate.md b/doc/commands/bbgo_tradeupdate.md index 1354f21c2..49ccd6764 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 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024 diff --git a/doc/commands/bbgo_transfer-history.md b/doc/commands/bbgo_transfer-history.md index f961d38b1..19c5fc57c 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 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024 diff --git a/doc/commands/bbgo_userdatastream.md b/doc/commands/bbgo_userdatastream.md index cf0044160..2923c0ff8 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 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024 diff --git a/doc/commands/bbgo_version.md b/doc/commands/bbgo_version.md index 71c77916d..84322f353 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 19-Mar-2024 +###### Auto generated by spf13/cobra on 14-May-2024