From 69baa8772bf0e30eee411677fd6b9c0367faaf35 Mon Sep 17 00:00:00 2001 From: c9s Date: Sun, 10 Jul 2022 15:29:19 +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 | 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 | 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 | 3 ++- doc/commands/bbgo_orderbook.md | 2 +- doc/commands/bbgo_orderupdate.md | 2 +- doc/commands/bbgo_pnl.md | 14 ++++++++------ 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 +- 28 files changed, 36 insertions(+), 33 deletions(-) diff --git a/doc/commands/bbgo.md b/doc/commands/bbgo.md index 1f3e6f89a..3b0722dc5 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 17-Jun-2022 +###### Auto generated by spf13/cobra on 10-Jul-2022 diff --git a/doc/commands/bbgo_account.md b/doc/commands/bbgo_account.md index 96c7d8e2a..5ac936af1 100644 --- a/doc/commands/bbgo_account.md +++ b/doc/commands/bbgo_account.md @@ -42,4 +42,4 @@ bbgo account [--session SESSION] [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 17-Jun-2022 +###### Auto generated by spf13/cobra on 10-Jul-2022 diff --git a/doc/commands/bbgo_backtest.md b/doc/commands/bbgo_backtest.md index 045d5c4c3..2400494cb 100644 --- a/doc/commands/bbgo_backtest.md +++ b/doc/commands/bbgo_backtest.md @@ -51,4 +51,4 @@ bbgo backtest [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 17-Jun-2022 +###### Auto generated by spf13/cobra on 10-Jul-2022 diff --git a/doc/commands/bbgo_balances.md b/doc/commands/bbgo_balances.md index 727f2939c..32f37a3e7 100644 --- a/doc/commands/bbgo_balances.md +++ b/doc/commands/bbgo_balances.md @@ -41,4 +41,4 @@ bbgo balances [--session SESSION] [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 17-Jun-2022 +###### Auto generated by spf13/cobra on 10-Jul-2022 diff --git a/doc/commands/bbgo_build.md b/doc/commands/bbgo_build.md index 5ed10a46b..9589df4de 100644 --- a/doc/commands/bbgo_build.md +++ b/doc/commands/bbgo_build.md @@ -40,4 +40,4 @@ bbgo build [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 17-Jun-2022 +###### Auto generated by spf13/cobra on 10-Jul-2022 diff --git a/doc/commands/bbgo_cancel-order.md b/doc/commands/bbgo_cancel-order.md index efd22f114..3bd47bc7d 100644 --- a/doc/commands/bbgo_cancel-order.md +++ b/doc/commands/bbgo_cancel-order.md @@ -50,4 +50,4 @@ bbgo cancel-order [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 17-Jun-2022 +###### Auto generated by spf13/cobra on 10-Jul-2022 diff --git a/doc/commands/bbgo_deposits.md b/doc/commands/bbgo_deposits.md index 9e0fd6dd5..e5b8e7b9c 100644 --- a/doc/commands/bbgo_deposits.md +++ b/doc/commands/bbgo_deposits.md @@ -42,4 +42,4 @@ bbgo deposits [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 17-Jun-2022 +###### Auto generated by spf13/cobra on 10-Jul-2022 diff --git a/doc/commands/bbgo_execute-order.md b/doc/commands/bbgo_execute-order.md index e276d34a9..9416533c4 100644 --- a/doc/commands/bbgo_execute-order.md +++ b/doc/commands/bbgo_execute-order.md @@ -49,4 +49,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 17-Jun-2022 +###### Auto generated by spf13/cobra on 10-Jul-2022 diff --git a/doc/commands/bbgo_get-order.md b/doc/commands/bbgo_get-order.md index ca8c30210..d4397c337 100644 --- a/doc/commands/bbgo_get-order.md +++ b/doc/commands/bbgo_get-order.md @@ -43,4 +43,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 17-Jun-2022 +###### Auto generated by spf13/cobra on 10-Jul-2022 diff --git a/doc/commands/bbgo_kline.md b/doc/commands/bbgo_kline.md index 9d20d5753..a5375712b 100644 --- a/doc/commands/bbgo_kline.md +++ b/doc/commands/bbgo_kline.md @@ -43,4 +43,4 @@ bbgo kline [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 17-Jun-2022 +###### Auto generated by spf13/cobra on 10-Jul-2022 diff --git a/doc/commands/bbgo_list-orders.md b/doc/commands/bbgo_list-orders.md index fb9e8a237..cfc5d6a9b 100644 --- a/doc/commands/bbgo_list-orders.md +++ b/doc/commands/bbgo_list-orders.md @@ -42,4 +42,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 17-Jun-2022 +###### Auto generated by spf13/cobra on 10-Jul-2022 diff --git a/doc/commands/bbgo_margin.md b/doc/commands/bbgo_margin.md index e7d422a94..873053045 100644 --- a/doc/commands/bbgo_margin.md +++ b/doc/commands/bbgo_margin.md @@ -39,4 +39,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 17-Jun-2022 +###### Auto generated by spf13/cobra on 10-Jul-2022 diff --git a/doc/commands/bbgo_margin_interests.md b/doc/commands/bbgo_margin_interests.md index 81049e839..017249e20 100644 --- a/doc/commands/bbgo_margin_interests.md +++ b/doc/commands/bbgo_margin_interests.md @@ -42,4 +42,4 @@ bbgo margin interests --session=SESSION_NAME --asset=ASSET [flags] * [bbgo margin](bbgo_margin.md) - margin related history -###### Auto generated by spf13/cobra on 17-Jun-2022 +###### Auto generated by spf13/cobra on 10-Jul-2022 diff --git a/doc/commands/bbgo_margin_loans.md b/doc/commands/bbgo_margin_loans.md index 0ccf268e3..d49f49bae 100644 --- a/doc/commands/bbgo_margin_loans.md +++ b/doc/commands/bbgo_margin_loans.md @@ -42,4 +42,4 @@ bbgo margin loans --session=SESSION_NAME --asset=ASSET [flags] * [bbgo margin](bbgo_margin.md) - margin related history -###### Auto generated by spf13/cobra on 17-Jun-2022 +###### Auto generated by spf13/cobra on 10-Jul-2022 diff --git a/doc/commands/bbgo_margin_repays.md b/doc/commands/bbgo_margin_repays.md index 5a1d8f4a4..5c42eaf00 100644 --- a/doc/commands/bbgo_margin_repays.md +++ b/doc/commands/bbgo_margin_repays.md @@ -42,4 +42,4 @@ bbgo margin repays --session=SESSION_NAME --asset=ASSET [flags] * [bbgo margin](bbgo_margin.md) - margin related history -###### Auto generated by spf13/cobra on 17-Jun-2022 +###### Auto generated by spf13/cobra on 10-Jul-2022 diff --git a/doc/commands/bbgo_market.md b/doc/commands/bbgo_market.md index 5bd9907b6..ccad4d2d0 100644 --- a/doc/commands/bbgo_market.md +++ b/doc/commands/bbgo_market.md @@ -41,4 +41,4 @@ bbgo market [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 17-Jun-2022 +###### Auto generated by spf13/cobra on 10-Jul-2022 diff --git a/doc/commands/bbgo_optimize.md b/doc/commands/bbgo_optimize.md index f29fcb3ed..856b60788 100644 --- a/doc/commands/bbgo_optimize.md +++ b/doc/commands/bbgo_optimize.md @@ -13,6 +13,7 @@ bbgo optimize [flags] --json print optimizer metrics in json format --optimizer-config string config file (default "optimizer.yaml") --output string backtest report output directory (default "output") + --tsv print optimizer metrics in csv format ``` ### Options inherited from parent commands @@ -43,4 +44,4 @@ bbgo optimize [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 17-Jun-2022 +###### Auto generated by spf13/cobra on 10-Jul-2022 diff --git a/doc/commands/bbgo_orderbook.md b/doc/commands/bbgo_orderbook.md index b81ccbaec..34870a613 100644 --- a/doc/commands/bbgo_orderbook.md +++ b/doc/commands/bbgo_orderbook.md @@ -43,4 +43,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 17-Jun-2022 +###### Auto generated by spf13/cobra on 10-Jul-2022 diff --git a/doc/commands/bbgo_orderupdate.md b/doc/commands/bbgo_orderupdate.md index 6f1a9397b..d7264a29a 100644 --- a/doc/commands/bbgo_orderupdate.md +++ b/doc/commands/bbgo_orderupdate.md @@ -41,4 +41,4 @@ bbgo orderupdate [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 17-Jun-2022 +###### Auto generated by spf13/cobra on 10-Jul-2022 diff --git a/doc/commands/bbgo_pnl.md b/doc/commands/bbgo_pnl.md index ce0cf8537..c518a3b29 100644 --- a/doc/commands/bbgo_pnl.md +++ b/doc/commands/bbgo_pnl.md @@ -13,11 +13,13 @@ bbgo pnl [flags] ### Options ``` - -h, --help help for pnl - --include-transfer convert transfer records into trades - --limit int number of trades - --session string target exchange - --symbol string trading symbol + -h, --help help for pnl + --include-transfer convert transfer records into trades + --limit uint number of trades + --session stringArray target exchange sessions + --since string query trades from a time point + --symbol string trading symbol + --sync sync before loading trades ``` ### Options inherited from parent commands @@ -48,4 +50,4 @@ bbgo pnl [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 17-Jun-2022 +###### Auto generated by spf13/cobra on 10-Jul-2022 diff --git a/doc/commands/bbgo_run.md b/doc/commands/bbgo_run.md index 73f52f3b0..4483ab20b 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 17-Jun-2022 +###### Auto generated by spf13/cobra on 10-Jul-2022 diff --git a/doc/commands/bbgo_submit-order.md b/doc/commands/bbgo_submit-order.md index eebe36247..280004c1f 100644 --- a/doc/commands/bbgo_submit-order.md +++ b/doc/commands/bbgo_submit-order.md @@ -45,4 +45,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 17-Jun-2022 +###### Auto generated by spf13/cobra on 10-Jul-2022 diff --git a/doc/commands/bbgo_sync.md b/doc/commands/bbgo_sync.md index 70d85fb01..0cd3d3af7 100644 --- a/doc/commands/bbgo_sync.md +++ b/doc/commands/bbgo_sync.md @@ -43,4 +43,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 17-Jun-2022 +###### Auto generated by spf13/cobra on 10-Jul-2022 diff --git a/doc/commands/bbgo_trades.md b/doc/commands/bbgo_trades.md index 14c7fcd9d..b44ee8ba2 100644 --- a/doc/commands/bbgo_trades.md +++ b/doc/commands/bbgo_trades.md @@ -43,4 +43,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 17-Jun-2022 +###### Auto generated by spf13/cobra on 10-Jul-2022 diff --git a/doc/commands/bbgo_tradeupdate.md b/doc/commands/bbgo_tradeupdate.md index 20da715ca..b1e428af1 100644 --- a/doc/commands/bbgo_tradeupdate.md +++ b/doc/commands/bbgo_tradeupdate.md @@ -41,4 +41,4 @@ bbgo tradeupdate --session=[exchange_name] [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 17-Jun-2022 +###### Auto generated by spf13/cobra on 10-Jul-2022 diff --git a/doc/commands/bbgo_transfer-history.md b/doc/commands/bbgo_transfer-history.md index dfdc67931..8cb40bd1c 100644 --- a/doc/commands/bbgo_transfer-history.md +++ b/doc/commands/bbgo_transfer-history.md @@ -43,4 +43,4 @@ bbgo transfer-history [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 17-Jun-2022 +###### Auto generated by spf13/cobra on 10-Jul-2022 diff --git a/doc/commands/bbgo_userdatastream.md b/doc/commands/bbgo_userdatastream.md index a8c102fd2..15a7240d3 100644 --- a/doc/commands/bbgo_userdatastream.md +++ b/doc/commands/bbgo_userdatastream.md @@ -41,4 +41,4 @@ bbgo userdatastream [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 17-Jun-2022 +###### Auto generated by spf13/cobra on 10-Jul-2022 diff --git a/doc/commands/bbgo_version.md b/doc/commands/bbgo_version.md index 23266c3c3..8cb05dcf1 100644 --- a/doc/commands/bbgo_version.md +++ b/doc/commands/bbgo_version.md @@ -40,4 +40,4 @@ bbgo version [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 17-Jun-2022 +###### Auto generated by spf13/cobra on 10-Jul-2022