lychiyu/bbgo_origin
1
0
Fork 0
mirror of https://github.com/c9s/bbgo.git synced 2024-11-25 16:25:16 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update command doc files

Browse Source
This commit is contained in:
c9s 2023-06-29 17:19:22 +08:00
parent 8a89408f0f
commit 7e894ef0cd
No known key found for this signature in database
GPG Key ID: 7385E7E464CB0A54
29 changed files with 58 additions and 116 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/commands/bbgo.md
View File

@ -15,10 +15,8 @@ bbgo [flags]
--cpu-profile string cpu profile
--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.
-h, --help help for bbgo
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -60,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-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023

6
doc/commands/bbgo_account.md
View File

@ -23,9 +23,7 @@ bbgo account [--session SESSION] [flags]
--cpu-profile string cpu profile
--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.
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -43,4 +41,4 @@ bbgo account [--session SESSION] [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 19-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023

6
doc/commands/bbgo_backtest.md
View File

@ -32,9 +32,7 @@ bbgo backtest [flags]
--cpu-profile string cpu profile
--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.
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -52,4 +50,4 @@ bbgo backtest [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 19-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023

6
doc/commands/bbgo_balances.md
View File

@ -22,9 +22,7 @@ bbgo balances [--session SESSION] [flags]
--cpu-profile string cpu profile
--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.
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -42,4 +40,4 @@ bbgo balances [--session SESSION] [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 19-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023

6
doc/commands/bbgo_build.md
View File

@ -21,9 +21,7 @@ bbgo build [flags]
--cpu-profile string cpu profile
--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.
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -41,4 +39,4 @@ bbgo build [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 19-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023

6
doc/commands/bbgo_cancel-order.md
View File

@ -31,9 +31,7 @@ bbgo cancel-order [flags]
--cpu-profile string cpu profile
--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.
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -51,4 +49,4 @@ bbgo cancel-order [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 19-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023

6
doc/commands/bbgo_deposits.md
View File

@ -23,9 +23,7 @@ bbgo deposits [flags]
--cpu-profile string cpu profile
--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.
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -43,4 +41,4 @@ bbgo deposits [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 19-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023

6
doc/commands/bbgo_execute-order.md
View File

@ -30,9 +30,7 @@ bbgo execute-order --session SESSION --symbol SYMBOL --side SIDE --target-quanti
--cpu-profile string cpu profile
--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.
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -50,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-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023

6
doc/commands/bbgo_get-order.md
View File

@ -24,9 +24,7 @@ bbgo get-order --session SESSION --order-id ORDER_ID [flags]
--cpu-profile string cpu profile
--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.
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -44,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-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023

6
doc/commands/bbgo_hoptimize.md
View File

@ -27,9 +27,7 @@ bbgo hoptimize [flags]
--cpu-profile string cpu profile
--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.
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -47,4 +45,4 @@ bbgo hoptimize [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 19-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023

6
doc/commands/bbgo_kline.md
View File

@ -24,9 +24,7 @@ bbgo kline [flags]
--cpu-profile string cpu profile
--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.
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -44,4 +42,4 @@ bbgo kline [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 19-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023

6
doc/commands/bbgo_list-orders.md
View File

@ -23,9 +23,7 @@ bbgo list-orders open|closed --session SESSION --symbol SYMBOL [flags]
--cpu-profile string cpu profile
--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.
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -43,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-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023

6
doc/commands/bbgo_margin.md
View File

@ -17,9 +17,7 @@ margin related history
--cpu-profile string cpu profile
--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.
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -40,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-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023

6
doc/commands/bbgo_margin_interests.md
View File

@ -23,9 +23,7 @@ bbgo margin interests --session=SESSION_NAME --asset=ASSET [flags]
--cpu-profile string cpu profile
--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.
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -43,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-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023

6
doc/commands/bbgo_margin_loans.md
View File

@ -23,9 +23,7 @@ bbgo margin loans --session=SESSION_NAME --asset=ASSET [flags]
--cpu-profile string cpu profile
--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.
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -43,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-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023

6
doc/commands/bbgo_margin_repays.md
View File

@ -23,9 +23,7 @@ bbgo margin repays --session=SESSION_NAME --asset=ASSET [flags]
--cpu-profile string cpu profile
--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.
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -43,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-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023

6
doc/commands/bbgo_market.md
View File

@ -22,9 +22,7 @@ bbgo market [flags]
--cpu-profile string cpu profile
--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.
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -42,4 +40,4 @@ bbgo market [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 19-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023

6
doc/commands/bbgo_optimize.md
View File

@ -26,9 +26,7 @@ bbgo optimize [flags]
--cpu-profile string cpu profile
--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.
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -46,4 +44,4 @@ bbgo optimize [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 19-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023

6
doc/commands/bbgo_orderbook.md
View File

@ -24,9 +24,7 @@ bbgo orderbook --session=[exchange_name] --symbol=[pair_name] [flags]
--cpu-profile string cpu profile
--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.
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -44,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-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023

6
doc/commands/bbgo_orderupdate.md
View File

@ -22,9 +22,7 @@ bbgo orderupdate [flags]
--cpu-profile string cpu profile
--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.
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -42,4 +40,4 @@ bbgo orderupdate [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 19-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023

6
doc/commands/bbgo_pnl.md
View File

@ -31,9 +31,7 @@ bbgo pnl [flags]
--cpu-profile string cpu profile
--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.
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -51,4 +49,4 @@ bbgo pnl [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 19-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023

6
doc/commands/bbgo_run.md
View File

@ -33,9 +33,7 @@ bbgo run [flags]
--cpu-profile string cpu profile
--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.
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -53,4 +51,4 @@ bbgo run [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 19-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023

6
doc/commands/bbgo_submit-order.md
View File

@ -28,9 +28,7 @@ bbgo submit-order --session SESSION --symbol SYMBOL --side SIDE --quantity QUANT
--cpu-profile string cpu profile
--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.
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -48,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-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023

6
doc/commands/bbgo_sync.md
View File

@ -24,9 +24,7 @@ bbgo sync [--session=[exchange_name]] [--symbol=[pair_name]] [[--since=yyyy/mm/d
--cpu-profile string cpu profile
--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.
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -44,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-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023

6
doc/commands/bbgo_trades.md
View File

@ -24,9 +24,7 @@ bbgo trades --session=[exchange_name] --symbol=[pair_name] [flags]
--cpu-profile string cpu profile
--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.
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -44,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-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023

6
doc/commands/bbgo_tradeupdate.md
View File

@ -22,9 +22,7 @@ bbgo tradeupdate --session=[exchange_name] [flags]
--cpu-profile string cpu profile
--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.
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -42,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-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023

6
doc/commands/bbgo_transfer-history.md
View File

@ -24,9 +24,7 @@ bbgo transfer-history [flags]
--cpu-profile string cpu profile
--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.
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -44,4 +42,4 @@ bbgo transfer-history [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 19-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023

6
doc/commands/bbgo_userdatastream.md
View File

@ -22,9 +22,7 @@ bbgo userdatastream [flags]
--cpu-profile string cpu profile
--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.
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -42,4 +40,4 @@ bbgo userdatastream [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 19-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023

6
doc/commands/bbgo_version.md
View File

@ -21,9 +21,7 @@ bbgo version [flags]
--cpu-profile string cpu profile
--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.
--log-formatter string configure log formatter
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
@ -41,4 +39,4 @@ bbgo version [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 19-Jun-2023
###### Auto generated by spf13/cobra on 29-Jun-2023