diff --git a/README.md b/README.md index a095a671..622eedc3 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,8 @@ An open-source kit for agent development, integrated the powerful capabilities of Volcengine. +For more details, see our [documents](https://volcengine.github.io/veadk-python/). + ## Installation We use `uv` to build this project ([how-to-install-uv](https://docs.astral.sh/uv/getting-started/installation/)). diff --git a/docs/docs/cli.md b/docs/docs/cli.md index f921fed1..c742bb3d 100644 --- a/docs/docs/cli.md +++ b/docs/docs/cli.md @@ -35,8 +35,14 @@ veadk deploy 可以通过`adk web`或`veadk studio`来启动Web页面,运行智能体: ```bash +# basic usage: adk web -# or + +# if you need to use long-term memory, you should use `veadk web`. +# if the `session_service_uri` is not set, it will use `opensearch` as your long-term memory backend +veadk web --session_service_uri="mysql+pymysql://{user}:{password}@{host}/{database}" + +# or, use our own web: veadk studio ```