This is an automated email from the ASF dual-hosted git repository.
wusheng pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/skywalking-banyandb.git
The following commit(s) were added to refs/heads/main by this push:
new e30bef9 Update clients.md (#216)
e30bef9 is described below
commit e30bef91753fd8efc1cd930e89ce08e21440ac71
Author: 吴晟 Wu Sheng <[email protected]>
AuthorDate: Fri Nov 18 12:14:19 2022 +0800
Update clients.md (#216)
---
docs/clients.md | 9 +++++++--
1 file changed, 7 insertions(+), 2 deletions(-)
diff --git a/docs/clients.md b/docs/clients.md
index c0a9022..2bd2b4b 100644
--- a/docs/clients.md
+++ b/docs/clients.md
@@ -9,7 +9,12 @@ These are several ways to install:
* Get binaries from [download](https://skywalking.apache.org/downloads/).
* Build from
[sources](https://github.com/apache/skywalking-banyandb/tree/main/bydbctl) to
get latest features.
-The config file named `.bydbctl.yaml` is located in `$HOME` folder.
+The config file named `.bydbctl.yaml` will be created in `$HOME` folder after
the first CRUD command is applied.
+```shell
+> more ~/.bydbctl.yaml
+addr: http://127.0.0.1:64299
+group: ""
+```
`bydbctl` leverages HTTP endpoints to retrieve data instead of gRPC.
@@ -49,4 +54,4 @@ If grpcurl is the CLI tool to access the APIs of BanyanDb. To
use `image.bin` wi
```shell
$ grpcurl -plaintext -protoset image.bin localhost:17912 ...
-```
\ No newline at end of file
+```
