diff --git a/Makefile b/Makefile index 5a6d59e1f..b6beb5f4d 100644 --- a/Makefile +++ b/Makefile @@ -131,7 +131,11 @@ pkg/version/dev.go: .FORCE dev-version: pkg/version/dev.go git commit $< -m "update dev build version" -version: pkg/version/version.go pkg/version/dev.go migrations +cmd-doc: .FORCE + go run ./cmd/update-doc + git add -v doc/commands + +version: pkg/version/version.go pkg/version/dev.go migrations cmd-doc git commit $< $(word 2,$^) -m "bump version to $(VERSION)" || true [[ -e doc/release/$(VERSION).md ]] || (echo "file doc/release/$(VERSION).md does not exist" ; exit 1) git add -v doc/release/$(VERSION).md && git commit doc/release/$(VERSION).md -m "add $(VERSION) release note" || true diff --git a/doc/commands/bbgo.md b/doc/commands/bbgo.md index 8b1c1a79a..4452439dc 100644 --- a/doc/commands/bbgo.md +++ b/doc/commands/bbgo.md @@ -39,6 +39,7 @@ bbgo [flags] * [bbgo cancel-order](bbgo_cancel-order.md) - cancel orders * [bbgo deposits](bbgo_deposits.md) - A testing utility that will query deposition history in last 7 days * [bbgo execute-order](bbgo_execute-order.md) - execute buy/sell on the balance/position you have on specific symbol +* [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 list-orders](bbgo_list-orders.md) - list user's open orders in exchange of a specific trading pair * [bbgo market](bbgo_market.md) - List the symbols that the are available to be traded in the exchange @@ -46,7 +47,7 @@ bbgo [flags] * [bbgo orderupdate](bbgo_orderupdate.md) - Listen to order update events * [bbgo pnl](bbgo_pnl.md) - pnl calculator * [bbgo run](bbgo_run.md) - run strategies from config file -* [bbgo submit-order](bbgo_submit-order.md) - submit limit order to the exchange +* [bbgo submit-order](bbgo_submit-order.md) - place limit order to the exchange * [bbgo sync](bbgo_sync.md) - sync trades and orders history * [bbgo trades](bbgo_trades.md) - Query trading history * [bbgo tradeupdate](bbgo_tradeupdate.md) - Listen to trade update events @@ -54,4 +55,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 22-Feb-2022 +###### Auto generated by spf13/cobra on 3-Mar-2022 diff --git a/doc/commands/bbgo_account.md b/doc/commands/bbgo_account.md index d7a58f2c5..fd75bf3bb 100644 --- a/doc/commands/bbgo_account.md +++ b/doc/commands/bbgo_account.md @@ -41,4 +41,4 @@ bbgo account [--session=[exchange_name]] [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 22-Feb-2022 +###### Auto generated by spf13/cobra on 3-Mar-2022 diff --git a/doc/commands/bbgo_backtest.md b/doc/commands/bbgo_backtest.md index 1c848dc54..a3d31bbe2 100644 --- a/doc/commands/bbgo_backtest.md +++ b/doc/commands/bbgo_backtest.md @@ -48,4 +48,4 @@ bbgo backtest [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 22-Feb-2022 +###### Auto generated by spf13/cobra on 3-Mar-2022 diff --git a/doc/commands/bbgo_balances.md b/doc/commands/bbgo_balances.md index 906084180..c318fa520 100644 --- a/doc/commands/bbgo_balances.md +++ b/doc/commands/bbgo_balances.md @@ -3,7 +3,7 @@ Show user account balances ``` -bbgo balances [flags] +bbgo balances --session SESSION [flags] ``` ### Options @@ -40,4 +40,4 @@ bbgo balances [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 22-Feb-2022 +###### Auto generated by spf13/cobra on 3-Mar-2022 diff --git a/doc/commands/bbgo_build.md b/doc/commands/bbgo_build.md index 98770cb41..492934b6b 100644 --- a/doc/commands/bbgo_build.md +++ b/doc/commands/bbgo_build.md @@ -39,4 +39,4 @@ bbgo build [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 22-Feb-2022 +###### Auto generated by spf13/cobra on 3-Mar-2022 diff --git a/doc/commands/bbgo_cancel-order.md b/doc/commands/bbgo_cancel-order.md index d11d12c92..c4b9e888e 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 22-Feb-2022 +###### Auto generated by spf13/cobra on 3-Mar-2022 diff --git a/doc/commands/bbgo_deposits.md b/doc/commands/bbgo_deposits.md index a17a9f01b..14478b17f 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 22-Feb-2022 +###### Auto generated by spf13/cobra on 3-Mar-2022 diff --git a/doc/commands/bbgo_execute-order.md b/doc/commands/bbgo_execute-order.md index a2a16d23f..d2497757d 100644 --- a/doc/commands/bbgo_execute-order.md +++ b/doc/commands/bbgo_execute-order.md @@ -3,7 +3,7 @@ execute buy/sell on the balance/position you have on specific symbol ``` -bbgo execute-order [flags] +bbgo execute-order --session SESSION --symbol SYMBOL --side SIDE --target-quantity TOTAL_QUANTITY --slice-quantity SLICE_QUANTITY [flags] ``` ### Options @@ -48,4 +48,4 @@ bbgo execute-order [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 22-Feb-2022 +###### Auto generated by spf13/cobra on 3-Mar-2022 diff --git a/doc/commands/bbgo_get-order.md b/doc/commands/bbgo_get-order.md new file mode 100644 index 000000000..e2c4f1794 --- /dev/null +++ b/doc/commands/bbgo_get-order.md @@ -0,0 +1,45 @@ +## bbgo get-order + +Get order status + +``` +bbgo get-order --session SESSION --order-id ORDER_ID [flags] +``` + +### Options + +``` + -h, --help help for get-order + --order-id string order id + --session string the exchange session name for sync + --symbol string the trading pair, like btcusdt +``` + +### 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 3-Mar-2022 diff --git a/doc/commands/bbgo_kline.md b/doc/commands/bbgo_kline.md index 1cda7459a..d8a87dc68 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 22-Feb-2022 +###### Auto generated by spf13/cobra on 3-Mar-2022 diff --git a/doc/commands/bbgo_list-orders.md b/doc/commands/bbgo_list-orders.md index b2652a091..67db66406 100644 --- a/doc/commands/bbgo_list-orders.md +++ b/doc/commands/bbgo_list-orders.md @@ -3,7 +3,7 @@ list user's open orders in exchange of a specific trading pair ``` -bbgo list-orders [status] [flags] +bbgo list-orders open|closed --session SESSION --symbol SYMBOL [flags] ``` ### Options @@ -41,4 +41,4 @@ bbgo list-orders [status] [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 22-Feb-2022 +###### Auto generated by spf13/cobra on 3-Mar-2022 diff --git a/doc/commands/bbgo_market.md b/doc/commands/bbgo_market.md index d4d93acec..e5c23fbdd 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 22-Feb-2022 +###### Auto generated by spf13/cobra on 3-Mar-2022 diff --git a/doc/commands/bbgo_orderbook.md b/doc/commands/bbgo_orderbook.md index 615be2c5a..bd1070677 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 22-Feb-2022 +###### Auto generated by spf13/cobra on 3-Mar-2022 diff --git a/doc/commands/bbgo_orderupdate.md b/doc/commands/bbgo_orderupdate.md index 864efa59e..66981f8d0 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 22-Feb-2022 +###### Auto generated by spf13/cobra on 3-Mar-2022 diff --git a/doc/commands/bbgo_pnl.md b/doc/commands/bbgo_pnl.md index 10b5fab48..bcbba17bd 100644 --- a/doc/commands/bbgo_pnl.md +++ b/doc/commands/bbgo_pnl.md @@ -43,4 +43,4 @@ bbgo pnl [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 22-Feb-2022 +###### Auto generated by spf13/cobra on 3-Mar-2022 diff --git a/doc/commands/bbgo_run.md b/doc/commands/bbgo_run.md index ff82e75f4..6b79d8933 100644 --- a/doc/commands/bbgo_run.md +++ b/doc/commands/bbgo_run.md @@ -49,4 +49,4 @@ bbgo run [flags] * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 22-Feb-2022 +###### Auto generated by spf13/cobra on 3-Mar-2022 diff --git a/doc/commands/bbgo_submit-order.md b/doc/commands/bbgo_submit-order.md index b3d180a2d..c6ded9639 100644 --- a/doc/commands/bbgo_submit-order.md +++ b/doc/commands/bbgo_submit-order.md @@ -1,6 +1,6 @@ ## bbgo submit-order -submit limit order to the exchange +place limit order to the exchange ``` bbgo submit-order --session SESSION --symbol SYMBOL --side SIDE --quantity QUANTITY [--price PRICE] [flags] @@ -44,4 +44,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 22-Feb-2022 +###### Auto generated by spf13/cobra on 3-Mar-2022 diff --git a/doc/commands/bbgo_sync.md b/doc/commands/bbgo_sync.md index 7db6f8446..f89d58b45 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/dd] [f * [bbgo](bbgo.md) - bbgo is a crypto trading bot -###### Auto generated by spf13/cobra on 22-Feb-2022 +###### Auto generated by spf13/cobra on 3-Mar-2022 diff --git a/doc/commands/bbgo_trades.md b/doc/commands/bbgo_trades.md index f6af8b238..a3a73ca90 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 22-Feb-2022 +###### Auto generated by spf13/cobra on 3-Mar-2022 diff --git a/doc/commands/bbgo_tradeupdate.md b/doc/commands/bbgo_tradeupdate.md index f5d4a31de..74ba5727b 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 22-Feb-2022 +###### Auto generated by spf13/cobra on 3-Mar-2022 diff --git a/doc/commands/bbgo_transfer-history.md b/doc/commands/bbgo_transfer-history.md index 6ad7a0b42..c80c90f93 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 22-Feb-2022 +###### Auto generated by spf13/cobra on 3-Mar-2022 diff --git a/doc/commands/bbgo_userdatastream.md b/doc/commands/bbgo_userdatastream.md index 514d43641..400cbcfee 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 22-Feb-2022 +###### Auto generated by spf13/cobra on 3-Mar-2022 diff --git a/doc/commands/bbgo_version.md b/doc/commands/bbgo_version.md index 97b7ab4be..ee828464a 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 22-Feb-2022 +###### Auto generated by spf13/cobra on 3-Mar-2022