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

update command doc files

Browse Source
This commit is contained in:
c9s 2022-12-23 13:08:05 +08:00
parent 8bcfb78bc0
commit 006ac7c2b3
No known key found for this signature in database
GPG Key ID: 7385E7E464CB0A54
29 changed files with 61 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/commands/bbgo.md
View File

@ -24,6 +24,7 @@ bbgo [flags]
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -59,4 +60,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 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022

3
doc/commands/bbgo_account.md
View File

@ -31,6 +31,7 @@ bbgo account [--session SESSION] [flags]
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -42,4 +43,4 @@ bbgo account [--session SESSION] [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022

5
doc/commands/bbgo_backtest.md
View File

@ -10,6 +10,7 @@ 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
@ -28,7 +29,6 @@ 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")
@ -40,6 +40,7 @@ bbgo backtest [flags]
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -51,4 +52,4 @@ bbgo backtest [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022

3
doc/commands/bbgo_balances.md
View File

@ -30,6 +30,7 @@ bbgo balances [--session SESSION] [flags]
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -41,4 +42,4 @@ bbgo balances [--session SESSION] [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022

7
doc/commands/bbgo_build.md
View File

@ -9,7 +9,8 @@ bbgo build [flags]
### Options
```
-h, --help help for build
--config string config file (default "bbgo.yaml")
-h, --help help for build
```
### Options inherited from parent commands
@ -17,7 +18,6 @@ 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")
@ -29,6 +29,7 @@ bbgo build [flags]
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -40,4 +41,4 @@ bbgo build [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022

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

@ -39,6 +39,7 @@ bbgo cancel-order [flags]
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -50,4 +51,4 @@ bbgo cancel-order [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022

3
doc/commands/bbgo_deposits.md
View File

@ -31,6 +31,7 @@ bbgo deposits [flags]
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -42,4 +43,4 @@ bbgo deposits [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022

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

@ -38,6 +38,7 @@ bbgo execute-order --session SESSION --symbol SYMBOL --side SIDE --target-quanti
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -49,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 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022

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

@ -32,6 +32,7 @@ bbgo get-order --session SESSION --order-id ORDER_ID [flags]
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -43,4 +44,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 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022

3
doc/commands/bbgo_hoptimize.md
View File

@ -35,6 +35,7 @@ bbgo hoptimize [flags]
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -46,4 +47,4 @@ bbgo hoptimize [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022

3
doc/commands/bbgo_kline.md
View File

@ -32,6 +32,7 @@ bbgo kline [flags]
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -43,4 +44,4 @@ bbgo kline [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022

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

@ -31,6 +31,7 @@ bbgo list-orders open|closed --session SESSION --symbol SYMBOL [flags]
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -42,4 +43,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 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022

3
doc/commands/bbgo_margin.md
View File

@ -25,6 +25,7 @@ margin related history
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -39,4 +40,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 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022

3
doc/commands/bbgo_margin_interests.md
View File

@ -31,6 +31,7 @@ bbgo margin interests --session=SESSION_NAME --asset=ASSET [flags]
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -42,4 +43,4 @@ bbgo margin interests --session=SESSION_NAME --asset=ASSET [flags]
* [bbgo margin](bbgo_margin.md) - margin related history
###### Auto generated by spf13/cobra on 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022

3
doc/commands/bbgo_margin_loans.md
View File

@ -31,6 +31,7 @@ bbgo margin loans --session=SESSION_NAME --asset=ASSET [flags]
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -42,4 +43,4 @@ bbgo margin loans --session=SESSION_NAME --asset=ASSET [flags]
* [bbgo margin](bbgo_margin.md) - margin related history
###### Auto generated by spf13/cobra on 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022

3
doc/commands/bbgo_margin_repays.md
View File

@ -31,6 +31,7 @@ bbgo margin repays --session=SESSION_NAME --asset=ASSET [flags]
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -42,4 +43,4 @@ bbgo margin repays --session=SESSION_NAME --asset=ASSET [flags]
* [bbgo margin](bbgo_margin.md) - margin related history
###### Auto generated by spf13/cobra on 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022

3
doc/commands/bbgo_market.md
View File

@ -30,6 +30,7 @@ bbgo market [flags]
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -41,4 +42,4 @@ bbgo market [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022

3
doc/commands/bbgo_optimize.md
View File

@ -34,6 +34,7 @@ bbgo optimize [flags]
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -45,4 +46,4 @@ bbgo optimize [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022

3
doc/commands/bbgo_orderbook.md
View File

@ -32,6 +32,7 @@ bbgo orderbook --session=[exchange_name] --symbol=[pair_name] [flags]
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -43,4 +44,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 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022

3
doc/commands/bbgo_orderupdate.md
View File

@ -30,6 +30,7 @@ bbgo orderupdate [flags]
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -41,4 +42,4 @@ bbgo orderupdate [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022

3
doc/commands/bbgo_pnl.md
View File

@ -39,6 +39,7 @@ bbgo pnl [flags]
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -50,4 +51,4 @@ bbgo pnl [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022

3
doc/commands/bbgo_run.md
View File

@ -41,6 +41,7 @@ bbgo run [flags]
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -52,4 +53,4 @@ bbgo run [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022

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

@ -36,6 +36,7 @@ bbgo submit-order --session SESSION --symbol SYMBOL --side SIDE --quantity QUANT
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -47,4 +48,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 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022

3
doc/commands/bbgo_sync.md
View File

@ -32,6 +32,7 @@ bbgo sync [--session=[exchange_name]] [--symbol=[pair_name]] [[--since=yyyy/mm/d
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -43,4 +44,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 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022

3
doc/commands/bbgo_trades.md
View File

@ -32,6 +32,7 @@ bbgo trades --session=[exchange_name] --symbol=[pair_name] [flags]
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -43,4 +44,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 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022

3
doc/commands/bbgo_tradeupdate.md
View File

@ -30,6 +30,7 @@ bbgo tradeupdate --session=[exchange_name] [flags]
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -41,4 +42,4 @@ bbgo tradeupdate --session=[exchange_name] [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022

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

@ -32,6 +32,7 @@ bbgo transfer-history [flags]
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -43,4 +44,4 @@ bbgo transfer-history [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022

3
doc/commands/bbgo_userdatastream.md
View File

@ -30,6 +30,7 @@ bbgo userdatastream [flags]
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -41,4 +42,4 @@ bbgo userdatastream [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022

3
doc/commands/bbgo_version.md
View File

@ -29,6 +29,7 @@ bbgo version [flags]
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--rollbar-token string rollbar token
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
@ -40,4 +41,4 @@ bbgo version [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 12-Oct-2022
###### Auto generated by spf13/cobra on 23-Dec-2022