From 6326526a08d1aed1bc6178393540e98db31d804c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E8=8E=98=E6=9D=83=20=E9=A9=AC?= <mashenquan@fuzhi.ai>
Date: Fri, 17 May 2024 13:28:28 +0800
Subject: [PATCH] feat: +vault config demo

---
 config/vault.example.yaml | 48 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)
 create mode 100644 config/vault.example.yaml

diff --git a/config/vault.example.yaml b/config/vault.example.yaml
new file mode 100644
index 000000000..0e197d2a8
--- /dev/null
+++ b/config/vault.example.yaml
@@ -0,0 +1,48 @@
+# Usage:
+# 1. Get value.
+# >>> from metagpt.tools.libs.env import get_env
+# >>> access_token = await get_env(key="access_token", app_name="github")
+# >>> print(access_token)
+# YOUR_ACCESS_TOKEN
+#
+# 2. Get description for LLM understanding.
+# >>> from metagpt.tools.libs.env import get_env_description
+# >>> descriptions = await get_env_description
+# >>> for k, desc in descriptions.items():
+# >>>     print(f"{key}:{desc}")
+# await get_env(key="access_token", app_name="github"):Get github access token
+# await get_env(key="access_token", app_name="gitlab"):Get gitlab access token
+# ...
+
+vault:
+  github:
+    values:
+      access_token: "YOUR_ACCESS_TOKEN"
+    descriptions:
+      access_token: "Get github access token"
+  gitlab:
+    values:
+      access_token: "YOUR_ACCESS_TOKEN"
+    descriptions:
+      access_token: "Get gitlab access token"
+  iflytek_tts:
+    values:
+      api_id: "YOUR_APP_ID"
+      api_key: "YOUR_API_KEY"
+      api_secret: "YOUR_API_SECRET"
+    descriptions:
+      api_id: "Get the API ID of IFlyTek Text to Speech"
+      api_key: "Get the API KEY of IFlyTek Text to Speech"
+      api_secret: "Get the API SECRET of IFlyTek Text to Speech"
+  azure_tts:
+    values:
+      subscription_key: "YOUR_SUBSCRIPTION_KEY"
+      region: "YOUR_REGION"
+    descriptions:
+      subscription_key: "Get the subscription key of Azure Text to Speech."
+      region: "Get the region of Azure Text to Speech."
+  default: # All key-value pairs whose app name is an empty string are placed below
+    values:
+      proxy: "YOUR_PROXY"
+    descriptions:
+      proxy: "Get proxy for tools like requests, playwright, selenium, etc."
\ No newline at end of file