Skip to content

Commit ee4df8d

Browse files
committed
docs: Updated documentation and optimized installation and configuration guide
(cherry picked from commit 2bd56580d8ef7f4823dd931ac5a85352d96d3ddf)
1 parent 97c7222 commit ee4df8d

File tree

6 files changed

+266
-24
lines changed

6 files changed

+266
-24
lines changed

docs/content/1.introduction/1.overview.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,13 @@ AgentKit 是火山引擎推出的企业级 AI Agent 开发平台,为开发者
66

77
## 核心优势
88

9-
- **声明式应用定义**:通过简洁的 YAML 文件定义智能体应用的核心组件和配置,实现一次定义,处处运行
9+
- **声明式应用定义**:通过简洁的 YAML 文件定义智能体应用的核心组件和配置,实现"一次定义,处处运行"
1010
- **模块化与可扩展**:内置丰富的 **Tool**(工具)、**Memory**(记忆)、**Knowledge**(知识库)等模块,并提供标准化的接口,方便开发者自定义和扩展。
1111
- **云原生部署**:与 **AgentKit Platform** 无缝集成,支持一键将应用部署到云端,并提供弹性伸缩、持续集成和高可用保障。
12-
- **多智能体协作(MCP)**:支持构建多个 **Agent** 协同工作的复杂系统,实现任务的分解、协作和汇总。
12+
- **多智能体协作**:支持构建多个 **Agent** 协同工作的复杂系统,实现任务的分解、协作和汇总,支持 A2A 协议 Agent
1313
- **全面的生命周期管理**:提供从项目初始化、本地调试、云端部署到线上运维的全套 `agentkit` CLI 工具链。
14+
- **多语言支持**:支持 Python 和 Golang 开发,满足不同技术栈需求。
15+
- **丰富的项目模板**:提供多种预置模板,包括基础应用、流式输出、A2A 协议等,快速启动开发。
1416

1517
## 架构理念
1618

@@ -26,7 +28,7 @@ AgentKit 的核心设计理念是将 **Agent App** 的**定义**与**执行**分
2628
- **智能问答机器人**:快速构建集成知识库的智能问答服务。
2729
- **自动化工作流**:创建能够自动执行一系列任务(如发送邮件、生成报告、调用 API)的自动化流程。
2830
- **复杂数据分析**:构建能够理解用户意图、查询数据库、分析数据并生成可视化报告的数据分析 **Agent**
29-
- **多智能体系统**:设计和部署多个 **Agent** 协同完成复杂任务的系统,例如研究员-分析师-报告员模式。
31+
- **多智能体系统**:设计和部署多个 **Agent** 协同完成复杂任务的系统,例如"研究员-分析师-报告员"模式。
3032

3133
## 开始使用
3234

docs/content/1.introduction/2.installation.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,14 +110,34 @@ agentkit --version
110110

111111
在使用 `agentkit` CLI 与 AgentKit Platform 交互之前,您需要配置访问凭证(AK/SK)。
112112

113-
将您的凭证设置为环境变量:
113+
### 推荐方式:使用全局配置
114+
115+
使用 AgentKit 的全局配置功能来安全地存储您的凭证:
116+
117+
```bash
118+
# 初始化全局配置
119+
agentkit config --global --init
120+
121+
# 设置您的访问凭证
122+
agentkit config --global --set volcengine.access_key="YOUR_ACCESS_KEY"
123+
agentkit config --global --set volcengine.secret_key="YOUR_SECRET_KEY"
124+
125+
# 验证配置
126+
agentkit config --global --show
127+
```
128+
129+
这种方式将凭证安全地存储在 `~/.agentkit/config.yaml` 文件中,避免在 shell 历史记录中暴露敏感信息。
130+
131+
### 环境变量方式(开发调试)
132+
133+
对于临时开发调试,您可以设置环境变量:
114134

115135
```bash
116136
export VOLCENGINE_ACCESS_KEY="YOUR_ACCESS_KEY"
117137
export VOLCENGINE_SECRET_KEY="YOUR_SECRET_KEY"
118138
```
119139

120-
为方便起见,您可以将以上命令添加到 Shell 的配置文件中(如 `~/.bashrc``~/.zshrc`)。
140+
⚠️ **注意**:出于安全考虑,不建议将包含敏感信息的 `export` 命令添加到 shell 配置文件(如 `~/.bashrc``~/.zshrc`中,因为这可能导致凭证泄露
121141

122142
## 下一步
123143

docs/content/1.introduction/3.quickstart.md

Lines changed: 49 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 快速入门
22

3-
本指南将引导您使用 “Basic Agent App” 模板开发一个简单的 **Agent**,快速体验 **AgentKit** 从开发、部署到测试的全流程。
3+
本指南将引导您使用 “Basic Agent App” 模板开发一个简单的 **Agent**,快速体验 **AgentKit** 从开发、部署到测试的全流程。AgentKit 提供多种模板,包括基础应用、流式输出、A2A 协议等,支持 Python 和 Golang 开发。
44

55
## 准备工作
66

@@ -30,7 +30,35 @@ export VOLCENGINE_SECRET_KEY=<your_secret_key>
3030
![API Key管理](../../public/images/model_apikey.jpg)
3131

3232
请记录下您的 **Endpoint ID**`ep-20250520174054-xxxxx`(也可以是模型ID如 `deepseek-v3-1-terminus`)和 **API Key**,后续将通过环境变量`MODEL_AGENT_NAME``MODEL_AGENT_API_KEY`配置给 **Agent**
33-
> 如果您不提供这些信息,**AgentKit Platform** 将在云端部署时自动为您注入一个内置的 `doubao-seed-1-6` 模型,本地调试也默认使用该内置模型。
33+
> 如果您不提供这些信息,**AgentKit Platform** 将在云端部署时自动为您注入一个内置的 `doubao-seed-1-6` 模型。
34+
35+
### 3. 本地调试凭证配置 (Local 模式必读)
36+
37+
如果您计划在本地 (Local 模式) 运行和调试 Agent,由于本地环境无法自动注入云端凭证,您**必须**手动配置访问凭证,否则 Agent 将无法调用大模型。
38+
39+
您可以通过以下两种方式之一配置凭证:
40+
41+
**方式一:配置方舟模型凭证**
42+
43+
直接指定要使用的模型接入点和 API Key:
44+
45+
```bash
46+
# 在 config 时通过 --runtime_envs (-e) 设置
47+
agentkit config -e MODEL_AGENT_NAME=<your_endpoint_id> -e MODEL_AGENT_API_KEY=<your_api_key>
48+
```
49+
50+
**方式二:配置火山引擎访问密钥**
51+
52+
如果配置了火山引擎的 AK/SK,veADK 会尝试自动获取您的模型访问权限:
53+
54+
```bash
55+
# 在 config 时通过 --runtime_envs (-e) 设置
56+
agentkit config -e VOLCENGINE_ACCESS_KEY=<your_access_key> -e VOLCENGINE_SECRET_KEY=<your_secret_key>
57+
```
58+
59+
> **注意**
60+
> 1. 在 Local 模式下,直接在宿主机 shell 中 `export` 环境变量对容器内无效,必须使用 `agentkit config -e` 将其写入 `agentkit.yaml``runtime_envs` 中。
61+
> 2. 在 Cloud 模式下,Runtime 会自动注入相关凭证,通常无需手动配置上述环境变量。
3462
3563
## 开始使用
3664

@@ -47,7 +75,18 @@ mkdir simple-agent && cd simple-agent
4775
agentkit init
4876
```
4977

50-
执行后会显示可用模板列表,选择模板 `1` (Basic Agent App):
78+
执行后会显示可用模板列表,选择模板 `1` (Basic Agent App)。您也可以使用 `--template` 参数直接指定模板:
79+
80+
```bash
81+
# 使用基础模板
82+
agentkit init --template basic
83+
84+
# 使用流式输出模板
85+
agentkit init --template basic_stream
86+
87+
# 查看所有可用模板
88+
agentkit init --list-templates
89+
```
5190

5291
命令执行后,将在当前目录生成模板代码和配置文件:
5392
```txt
@@ -70,19 +109,19 @@ agentkit config
70109
配置向导会引导您完成以下设置:
71110

72111
**通用配置**(按 回车 使用默认值):
73-
- **1.应用名称**:Agent 应用名称(模板1,默认值为 `simple_agent`如接纳直接回车即可(下同)
74-
- **2.入口文件**:应用入口文件(模板1,默认值为 `simple_agent.py`
112+
- **1.应用名称**:Agent 应用名称(默认值为 `simple_agent`可直接按回车使用默认值
113+
- **2.入口文件**:应用入口文件(默认值为 `simple_agent.py`
75114
- **3.应用描述**:应用描述信息(可选)
76-
- **4.Python 版本**:默认 3.12
77-
- **5.依赖文件**:默认 `requirements.txt`
115+
- **4.编程语言**Python 或 Golang(默认 Python)
116+
- **5.依赖文件**:默认 `requirements.txt``go.mod`
78117
- **6.Agent应用内部Runtime常用环境变量**
79118
- `MODEL_AGENT_NAME`:方舟模型接入点 ID(可选)
80119
- `MODEL_AGENT_API_KEY`:方舟模型 API Key(可选)
81120
- **7.部署模式**:选择 `cloud`(云端构建和部署)
82121

83122
**云端部署配置**
84123
- **1.服务区域**:默认 `cn-beijing`
85-
- **2.镜像标签**:默认 `latest`
124+
- **2.镜像标签**:默认 `{{timestamp}}`, 会自动渲染为时间戳,格式如20251218154940
86125
- **3.CR 镜像仓库**:CLI 会自动生成CR实例名称、CR命名空间和CR仓库名,用户也可手动指定(建议自动即可)
87126

88127
完成配置后,执行 `launch` 命令即可一键部署:
@@ -142,4 +181,5 @@ Using default headers: {'user_id': 'agentkit_user', 'session_id': 'agentkit_samp
142181

143182
接下来您可以:
144183
- 探索其他应用模板(MCP、A2A 等)
145-
- 集成 Memory、Knowledge 等 Platform 服务,开发更强大的 **Agent**
184+
- 集成 Memory、Knowledge、Tools 等 Platform 服务,开发更强大的 **Agent**
185+
- 使用 `agentkit memory``agentkit knowledge``agentkit tools` 等命令管理平台服务

docs/content/1.introduction/4.troubleshooting.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,10 @@
2828
source .venv/bin/activate
2929
uv pip install agentkit-sdk-python
3030
```
31-
- 强制重新安装: 如果不想使用虚拟环境,可以尝试强制重新安装 AgentKit 及其依赖。
31+
- 清理环境重新安装: 如果必须使用现有环境,建议先卸载再重新安装:
3232
```bash
33-
pip install --force-reinstall agentkit-sdk-python
33+
pip uninstall agentkit-sdk-python
34+
pip install agentkit-sdk-python
3435
```
3536
## 配置问题
3637

@@ -39,7 +40,7 @@
3940
- **现象**:提示无法连接到 AgentKit Platform 或认证失败。
4041
- **原因**:可能未传入环境变量或传入了错误的环境变量名称
4142
- **解决方案**
42-
- 确认已设置必需的环境变
43+
- 确认已设置必需的环境变量
4344
```bash
4445
echo $VOLCENGINE_ACCESS_KEY
4546
echo $VOLCENGINE_SECRET_KEY

docs/content/2.agentkit-cli/1.overview.md

Lines changed: 43 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414

1515
`agentkit` CLI 提供了一系列直观的命令来管理您的 **Agent** 应用:
1616

17+
### 核心命令
1718
| 命令 | 功能描述 |
1819
| :--- | :--- |
1920
| `agentkit init` | 初始化一个新的 **Agent** 项目,可选择不同的模板。 |
@@ -25,6 +26,14 @@
2526
| `agentkit status` | 查看 **Agent** 的运行状态和 Endpoint。 |
2627
| `agentkit destroy` | 停止并销毁 **Agent** 实例,释放相关资源。 |
2728

29+
### 平台服务命令
30+
| 命令 | 功能描述 |
31+
| :--- | :--- |
32+
| `agentkit memory` | 管理 AgentKit Memory 记忆集合。 |
33+
| `agentkit knowledge` | 管理 AgentKit Knowledge 知识库。 |
34+
| `agentkit tools` | 管理 AgentKit Tools 工具和 Sessions 会话。 |
35+
| `agentkit runtime` | 管理 AgentKit Runtime 运行时实例。 |
36+
2837
> 想要了解每个命令的详细用法?请查阅 [命令详解](./2.commands.md)
2938
3039
## 三种部署模式
@@ -84,6 +93,10 @@ launch_types:
8493
mkdir my-first-agent && cd my-first-agent
8594
agentkit init my-first-agent
8695

96+
# 或者指定特定模板
97+
agentkit init my-first-agent --template basic_stream # 流式输出模板
98+
agentkit init my-first-agent --template a2a # A2A 协议模板
99+
87100
# 2. 配置应用 (通过交互式向导)
88101
agentkit config
89102

@@ -100,23 +113,49 @@ agentkit status
100113
agentkit destroy
101114
```
102115

116+
### 探索更多功能
117+
118+
```bash
119+
# 查看可用模板
120+
agentkit init --list-templates
121+
122+
# 管理平台服务
123+
agentkit memory list # 查看记忆集合
124+
agentkit knowledge list # 查看知识库
125+
agentkit tools list # 查看工具列表
126+
agentkit runtime list # 查看运行时实例
127+
```
128+
103129
## 环境要求
104130

105131
### ✅ 基础环境(所有模式)
106-
- Python 3.12 或更高版本
132+
- Python 3.10 或更高版本
107133
- pip 包管理器
108134
- 已安装 AgentKit SDK
109135

136+
### 🐍 Python 开发环境
137+
- Python 3.10, 3.11, 3.12, 3.13 版本支持
138+
- 推荐使用 `requirements.txt` 管理依赖
139+
140+
### 🐹 Golang 开发环境
141+
- Golang 1.24 版本支持
142+
- 使用 `go.mod` 管理依赖
143+
- 适用于高性能场景
144+
110145
### 🐳 本地开发(Local/Hybrid 模式)
111146
- Docker Desktop 或 Docker Engine 20.10+
112147
- 确保 Docker 服务已启动
113148

114149
### ☁️ 云端部署(Cloud/Hybrid 模式)
115150
- 火山引擎账号
116-
- 配置好 AK/SK 环境变量
151+
- 配置访问凭证(AK/SK),推荐使用安全的全局配置方式
117152
```bash
118-
export VOLC_ACCESSKEY="your_access_key"
119-
export VOLC_SECRETKEY="your_secret_key"
153+
# 初始化全局配置
154+
agentkit config --global --init
155+
156+
# 设置访问凭证
157+
agentkit config --global --set volcengine.access_key="your_access_key"
158+
agentkit config --global --set volcengine.secret_key="your_secret_key"
120159
```
121160

122161
## 下一步

0 commit comments

Comments
 (0)