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 2022-06-07 22:24:47 +08:00
parent 0f9e0d3055
commit 53a29b1eac
No known key found for this signature in database
GPG Key ID: 7385E7E464CB0A54
28 changed files with 252 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/commands/bbgo.md
View File

@ -33,7 +33,7 @@ bbgo [flags]
### SEE ALSO ### SEE ALSO
* [bbgo account](bbgo_account.md) - show user account details (ex: balance) * [bbgo account](bbgo_account.md) - show user account details (ex: balance)
* [bbgo backtest](bbgo_backtest.md) - backtest your strategies * [bbgo backtest](bbgo_backtest.md) - run backtest with strategies
* [bbgo balances](bbgo_balances.md) - Show user account balances * [bbgo balances](bbgo_balances.md) - Show user account balances
* [bbgo build](bbgo_build.md) - build cross-platform binary * [bbgo build](bbgo_build.md) - build cross-platform binary
* [bbgo cancel-order](bbgo_cancel-order.md) - cancel orders * [bbgo cancel-order](bbgo_cancel-order.md) - cancel orders
@ -42,7 +42,9 @@ bbgo [flags]
* [bbgo get-order](bbgo_get-order.md) - Get order status * [bbgo get-order](bbgo_get-order.md) - Get order status
* [bbgo kline](bbgo_kline.md) - connect to the kline market data streaming service of an exchange * [bbgo kline](bbgo_kline.md) - connect to the kline market data streaming service of an exchange
* [bbgo list-orders](bbgo_list-orders.md) - list user's open orders in exchange of a specific trading pair * [bbgo list-orders](bbgo_list-orders.md) - list user's open orders in exchange of a specific trading pair
* [bbgo margin](bbgo_margin.md) - margin related history
* [bbgo market](bbgo_market.md) - List the symbols that the are available to be traded in the exchange * [bbgo market](bbgo_market.md) - List the symbols that the are available to be traded in the exchange
* [bbgo optimize](bbgo_optimize.md) - run optimizer
* [bbgo orderbook](bbgo_orderbook.md) - connect to the order book market data streaming service of an exchange * [bbgo orderbook](bbgo_orderbook.md) - connect to the order book market data streaming service of an exchange
* [bbgo orderupdate](bbgo_orderupdate.md) - Listen to order update events * [bbgo orderupdate](bbgo_orderupdate.md) - Listen to order update events
* [bbgo pnl](bbgo_pnl.md) - pnl calculator * [bbgo pnl](bbgo_pnl.md) - pnl calculator
@ -55,4 +57,4 @@ bbgo [flags]
* [bbgo userdatastream](bbgo_userdatastream.md) - Listen to session events (orderUpdate, tradeUpdate, balanceUpdate, balanceSnapshot) * [bbgo userdatastream](bbgo_userdatastream.md) - Listen to session events (orderUpdate, tradeUpdate, balanceUpdate, balanceSnapshot)
* [bbgo version](bbgo_version.md) - show version name * [bbgo version](bbgo_version.md) - show version name
###### Auto generated by spf13/cobra on 5-May-2022 ###### Auto generated by spf13/cobra on 7-Jun-2022

2
doc/commands/bbgo_account.md
View File

@ -41,4 +41,4 @@ bbgo account [--session SESSION] [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot * [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 5-May-2022 ###### Auto generated by spf13/cobra on 7-Jun-2022

6
doc/commands/bbgo_backtest.md
View File

@ -1,6 +1,6 @@
## bbgo backtest ## bbgo backtest
backtest your strategies run backtest with strategies
``` ```
bbgo backtest [flags] bbgo backtest [flags]
@ -13,6 +13,8 @@ bbgo backtest [flags]
--force force execution without confirm --force force execution without confirm
-h, --help help for backtest -h, --help help for backtest
--output string the report output directory --output string the report output directory
--session string specify only one exchange session to run backtest
--subdir generate report in the sub-directory of the output directory
--sync sync backtest data --sync sync backtest data
--sync-exchange string specify only one exchange to sync backtest data --sync-exchange string specify only one exchange to sync backtest data
--sync-from string sync backtest data from the given time, which will override the time range in the backtest config --sync-from string sync backtest data from the given time, which will override the time range in the backtest config
@ -48,4 +50,4 @@ bbgo backtest [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot * [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 5-May-2022 ###### Auto generated by spf13/cobra on 7-Jun-2022

2
doc/commands/bbgo_balances.md
View File

@ -40,4 +40,4 @@ bbgo balances [--session SESSION] [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot * [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 5-May-2022 ###### Auto generated by spf13/cobra on 7-Jun-2022

2
doc/commands/bbgo_build.md
View File

@ -39,4 +39,4 @@ bbgo build [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot * [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 5-May-2022 ###### Auto generated by spf13/cobra on 7-Jun-2022

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

@ -49,4 +49,4 @@ bbgo cancel-order [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot * [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 5-May-2022 ###### Auto generated by spf13/cobra on 7-Jun-2022

2
doc/commands/bbgo_deposits.md
View File

@ -41,4 +41,4 @@ bbgo deposits [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot * [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 5-May-2022 ###### Auto generated by spf13/cobra on 7-Jun-2022

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

@ -48,4 +48,4 @@ bbgo execute-order --session SESSION --symbol SYMBOL --side SIDE --target-quanti
* [bbgo](bbgo.md) - bbgo is a crypto trading bot * [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 5-May-2022 ###### Auto generated by spf13/cobra on 7-Jun-2022

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

@ -42,4 +42,4 @@ bbgo get-order --session SESSION --order-id ORDER_ID [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot * [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 5-May-2022 ###### Auto generated by spf13/cobra on 7-Jun-2022

2
doc/commands/bbgo_kline.md
View File

@ -42,4 +42,4 @@ bbgo kline [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot * [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 5-May-2022 ###### Auto generated by spf13/cobra on 7-Jun-2022

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

@ -41,4 +41,4 @@ bbgo list-orders open|closed --session SESSION --symbol SYMBOL [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot * [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 5-May-2022 ###### Auto generated by spf13/cobra on 7-Jun-2022

41
doc/commands/bbgo_margin.md Normal file
View File

@ -0,0 +1,41 @@
## bbgo margin
margin related history
### Options
```
-h, --help help for margin
```
### Options inherited from parent commands
```
--binance-api-key string binance api key
--binance-api-secret string binance api secret
--config string config file (default "bbgo.yaml")
--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.
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
--telegram-bot-auth-token string telegram auth token
--telegram-bot-token string telegram bot token from bot father
```
### SEE ALSO
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
* [bbgo margin interests](bbgo_margin_interests.md) - query interests 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 7-Jun-2022

44
doc/commands/bbgo_margin_interests.md Normal file
View File

@ -0,0 +1,44 @@
## bbgo margin interests
query interests history
```
bbgo margin interests --session=SESSION_NAME --asset=ASSET [flags]
```
### Options
```
--asset string asset
-h, --help help for interests
--session string exchange session name
```
### Options inherited from parent commands
```
--binance-api-key string binance api key
--binance-api-secret string binance api secret
--config string config file (default "bbgo.yaml")
--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.
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
--telegram-bot-auth-token string telegram auth token
--telegram-bot-token string telegram bot token from bot father
```
### SEE ALSO
* [bbgo margin](bbgo_margin.md) - margin related history
###### Auto generated by spf13/cobra on 7-Jun-2022

44
doc/commands/bbgo_margin_loans.md Normal file
View File

@ -0,0 +1,44 @@
## bbgo margin loans
query loans history
```
bbgo margin loans --session=SESSION_NAME --asset=ASSET [flags]
```
### Options
```
--asset string asset
-h, --help help for loans
--session string exchange session name
```
### Options inherited from parent commands
```
--binance-api-key string binance api key
--binance-api-secret string binance api secret
--config string config file (default "bbgo.yaml")
--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.
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
--telegram-bot-auth-token string telegram auth token
--telegram-bot-token string telegram bot token from bot father
```
### SEE ALSO
* [bbgo margin](bbgo_margin.md) - margin related history
###### Auto generated by spf13/cobra on 7-Jun-2022

44
doc/commands/bbgo_margin_repays.md Normal file
View File

@ -0,0 +1,44 @@
## bbgo margin repays
query repay history
```
bbgo margin repays --session=SESSION_NAME --asset=ASSET [flags]
```
### Options
```
--asset string asset
-h, --help help for repays
--session string exchange session name
```
### Options inherited from parent commands
```
--binance-api-key string binance api key
--binance-api-secret string binance api secret
--config string config file (default "bbgo.yaml")
--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.
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
--telegram-bot-auth-token string telegram auth token
--telegram-bot-token string telegram bot token from bot father
```
### SEE ALSO
* [bbgo margin](bbgo_margin.md) - margin related history
###### Auto generated by spf13/cobra on 7-Jun-2022

2
doc/commands/bbgo_market.md
View File

@ -40,4 +40,4 @@ bbgo market [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot * [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 5-May-2022 ###### Auto generated by spf13/cobra on 7-Jun-2022

45
doc/commands/bbgo_optimize.md Normal file
View File

@ -0,0 +1,45 @@
## bbgo optimize
run optimizer
```
bbgo optimize [flags]
```
### Options
```
-h, --help help for optimize
--json print optimizer metrics in json format
--optimizer-config string config file (default "optimizer.yaml")
--output string backtest report output directory (default "output")
```
### Options inherited from parent commands
```
--binance-api-key string binance api key
--binance-api-secret string binance api secret
--config string config file (default "bbgo.yaml")
--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.
--max-api-key string max api key
--max-api-secret string max api secret
--metrics enable prometheus metrics
--metrics-port string prometheus http server port (default "9090")
--no-dotenv disable built-in dotenv
--slack-channel string slack trading channel (default "dev-bbgo")
--slack-error-channel string slack error channel (default "bbgo-error")
--slack-token string slack token
--telegram-bot-auth-token string telegram auth token
--telegram-bot-token string telegram bot token from bot father
```
### SEE ALSO
* [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 7-Jun-2022

2
doc/commands/bbgo_orderbook.md
View File

@ -42,4 +42,4 @@ bbgo orderbook --session=[exchange_name] --symbol=[pair_name] [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot * [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 5-May-2022 ###### Auto generated by spf13/cobra on 7-Jun-2022

2
doc/commands/bbgo_orderupdate.md
View File

@ -40,4 +40,4 @@ bbgo orderupdate [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot * [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 5-May-2022 ###### Auto generated by spf13/cobra on 7-Jun-2022

2
doc/commands/bbgo_pnl.md
View File

@ -43,4 +43,4 @@ bbgo pnl [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot * [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 5-May-2022 ###### Auto generated by spf13/cobra on 7-Jun-2022

2
doc/commands/bbgo_run.md
View File

@ -51,4 +51,4 @@ bbgo run [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot * [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 5-May-2022 ###### Auto generated by spf13/cobra on 7-Jun-2022

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

@ -44,4 +44,4 @@ bbgo submit-order --session SESSION --symbol SYMBOL --side SIDE --quantity QUANT
* [bbgo](bbgo.md) - bbgo is a crypto trading bot * [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 5-May-2022 ###### Auto generated by spf13/cobra on 7-Jun-2022

12
doc/commands/bbgo_sync.md
View File

@ -3,16 +3,16 @@
sync trades and orders history sync trades and orders history
``` ```
bbgo sync --session=[exchange_name] --symbol=[pair_name] [--since=yyyy/mm/dd] [flags] bbgo sync [--session=[exchange_name]] [--symbol=[pair_name]] [[--since=yyyy/mm/dd]] [flags]
``` ```
### Options ### Options
``` ```
-h, --help help for sync -h, --help help for sync
--session string the exchange session name for sync --session stringArray the exchange session name for sync
--since string sync from time --since string sync from time
--symbol string symbol of market for syncing --symbol string symbol of market for syncing
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -42,4 +42,4 @@ bbgo sync --session=[exchange_name] --symbol=[pair_name] [--since=yyyy/mm/dd] [f
* [bbgo](bbgo.md) - bbgo is a crypto trading bot * [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 5-May-2022 ###### Auto generated by spf13/cobra on 7-Jun-2022

2
doc/commands/bbgo_trades.md
View File

@ -42,4 +42,4 @@ bbgo trades --session=[exchange_name] --symbol=[pair_name] [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot * [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 5-May-2022 ###### Auto generated by spf13/cobra on 7-Jun-2022

2
doc/commands/bbgo_tradeupdate.md
View File

@ -40,4 +40,4 @@ bbgo tradeupdate --session=[exchange_name] [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot * [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 5-May-2022 ###### Auto generated by spf13/cobra on 7-Jun-2022

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

@ -42,4 +42,4 @@ bbgo transfer-history [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot * [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 5-May-2022 ###### Auto generated by spf13/cobra on 7-Jun-2022

2
doc/commands/bbgo_userdatastream.md
View File

@ -40,4 +40,4 @@ bbgo userdatastream [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot * [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 5-May-2022 ###### Auto generated by spf13/cobra on 7-Jun-2022

2
doc/commands/bbgo_version.md
View File

@ -39,4 +39,4 @@ bbgo version [flags]
* [bbgo](bbgo.md) - bbgo is a crypto trading bot * [bbgo](bbgo.md) - bbgo is a crypto trading bot
###### Auto generated by spf13/cobra on 5-May-2022 ###### Auto generated by spf13/cobra on 7-Jun-2022