From c3ba1bcdfe145cf6e33edf54aff54f9deec7f00c Mon Sep 17 00:00:00 2001 From: "fangyaozheng@bytedance.com" Date: Mon, 4 Aug 2025 15:03:16 +0800 Subject: [PATCH 1/2] docs: add veadk web cli description --- docs/docs/cli.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) 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 ``` From 8ade6b09443d7119ed7d37e0b3e159eb16f0d771 Mon Sep 17 00:00:00 2001 From: yaozheng-fang Date: Mon, 4 Aug 2025 15:21:26 +0800 Subject: [PATCH 2/2] chore: add document link to README.md (#12) --- README.md | 2 ++ 1 file changed, 2 insertions(+) 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/)).