/ config / vault.example.yaml
vault.example.yaml
 1  # Usage:
 2  # 1. Get value.
 3  # >>> from metagpt.tools.libs.env import get_env
 4  # >>> access_token = await get_env(key="access_token", app_name="github")
 5  # >>> print(access_token)
 6  # YOUR_ACCESS_TOKEN
 7  #
 8  # 2. Get description for LLM understanding.
 9  # >>> from metagpt.tools.libs.env import get_env_description
10  # >>> descriptions = await get_env_description
11  # >>> for k, desc in descriptions.items():
12  # >>>     print(f"{key}:{desc}")
13  # await get_env(key="access_token", app_name="github"):Get github access token
14  # await get_env(key="access_token", app_name="gitlab"):Get gitlab access token
15  # ...
16  
17  vault:
18    github:
19      values:
20        access_token: "YOUR_ACCESS_TOKEN"
21      descriptions:
22        access_token: "Get github access token"
23    gitlab:
24      values:
25        access_token: "YOUR_ACCESS_TOKEN"
26      descriptions:
27        access_token: "Get gitlab access token"
28    iflytek_tts:
29      values:
30        api_id: "YOUR_APP_ID"
31        api_key: "YOUR_API_KEY"
32        api_secret: "YOUR_API_SECRET"
33      descriptions:
34        api_id: "Get the API ID of IFlyTek Text to Speech"
35        api_key: "Get the API KEY of IFlyTek Text to Speech"
36        api_secret: "Get the API SECRET of IFlyTek Text to Speech"
37    azure_tts:
38      values:
39        subscription_key: "YOUR_SUBSCRIPTION_KEY"
40        region: "YOUR_REGION"
41      descriptions:
42        subscription_key: "Get the subscription key of Azure Text to Speech."
43        region: "Get the region of Azure Text to Speech."
44    default: # All key-value pairs whose app name is an empty string are placed below
45      values:
46        proxy: "YOUR_PROXY"
47      descriptions:
48        proxy: "Get proxy for tools like requests, playwright, selenium, etc."