You need to enable JavaScript to run this app.
文档中心
AgentKit

AgentKit

复制全文
下载 pdf
CLI 参考
CLI 概述
复制全文
下载 pdf
CLI 概述
AgentKit CLI 简介​
AgentKit CLI 是一个命令行工具,用于简化 Agent 应用的全生命周期管理,从脚手架项目、构建并部署运行时,到调用已部署的智能体,再到管理其依赖的 MCP 服务、知识库、记忆、沙箱、技能与评测,均可在终端完成。了解更多​
当前 CLI 已预置以下 Agent 示例模板供您选择,您也可以使用自研代码:​
  • Basic Agent App:最简单的 Agent 应用,快速上手。​
  • Basic Stream Agent App:支持流式输出的 Agent 应用,使用 VeADK。​
优势​
  • 声明式配置:所有配置通过一个agentkit.yaml文件管理,清晰、可移植且易于版本控制。​
  • 多环境部署:无缝支持本地开发、混合部署和纯云端部署三种模式,满足不同场景需求。​
  • 一键式操作:通过agentkit launch等高级命令,将构建、部署等多个步骤合而为一,极大提升效率。​
  • 模板化项目:内置多种应用模板,帮助您快速启动项目,无需从零开始。​
  • 智能交互:提供agentkit config等交互式向导,引导您完成配置,降低学习成本。​
主要命令​
AgentKit CLI 提供了一系列直观的命令来管理您的 Agent 应用,遵循标准的agentkit <command> [arguments] [options] 格式。了解更多​
核心命令​
​
命令​
功能说明​
agentkit init​
初始化一个新的 Agent 项目,可选择不同的模板。​
agentkit add​
生成并增量更新 harness 配置文件,或添加凭证(credential)。​
agentkit list​
列出以 harness 方式部署的运行时,或列出凭证。​
agentkit delete​
按名称删除凭证(credential)。​
agentkit config​
通过交互式向导配置 agentkit.yaml 文件。​
agentkit build​
将您的 Agent 应用构建为 Docker 镜像。​
agentkit deploy​
将已构建的镜像部署到指定环境 (本地或云端)。​
agentkit launch​
一键完成构建和部署,是开发中最常用的命令。​
agentkit invoke​
与已部署的 Agent 进行交互,用于快速测试。​
agentkit status​
查看 Agent 的运行状态和 Endpoint。​
agentkit destroy​
停止并销毁 Agent 实例,释放相关资源。​
​
平台服务命令​
​
命令​
功能说明​
agentkit memory​
管理 AgentKit Memory 记忆集合。​
agentkit knowledge​
管理 AgentKit Knowledge 知识库。​
agentkit tools​
管理 AgentKit Tools 工具和 Sessions 会话。​
agentkit runtime​
管理 AgentKit Runtime 运行时实例。​
​
通用命令​
​
命令​
功能说明​
--help​
查看任何命令的详细说明和参数。​
--version​
显示 CLI 版本信息。​
​
部署模式​
AgentKit CLI 支持灵活的启动模型,旨在适应从开发到生产的不同阶段。了解更多​
本地模式(Local)​
在您的本地机器上完成构建和部署,非常适合快速开发和调试。​
  • 工作流: 源代码 → 本地 Docker 构建 → 本地容器运行​
  • 优势: 迭代速度快,支持离线工作,便于直接调试。​
云端模式(Cloud)​
将代码的构建和部署完全托管在 AgentKit 上,是生产环境的最佳实践。​
  • 工作流: 源代码 → 云端自动构建 → 云端镜像仓库 → 生产级 Runtime​
  • 优势: 无需本地 Docker 环境,内置可观测性,环境一致性高,安全可靠。​
混合模式(Hybrid)​
在本地构建镜像,然后将其推送到云端 AgentKit 进行部署。这种模式结合了本地控制和云端能力的优点。​
  • 工作流: 源代码 → 本地 Docker 构建 → 上传至云端镜像仓库 → 生产级 Runtime​
  • 优势: 兼顾本地构建的灵活性和云端运行环境的稳定性,适合需要自定义构建流程的场景。​
配置文件(agentkit.yaml)​
agentkit.yaml是 AgentKit 项目的核心,它以声明式的方式定义了应用的所有配置。强烈建议使用agentkit config命令来管理此文件。了解更多​
​
# 通用配置​
common:​
agent_name: my-agent​
entry_point: app.py​
python_version: '3.12'​
launch_type: cloud # 定义默认的部署模式​
​
# 不同部署模式的特定配置​
launch_types:​
cloud:​
region: cn-beijing​
image_tag: latest​
runtime_envs:​
MODEL_API_KEY: "your-api-key"​
​
环境要求​
基础环境(所有模式)​
  • Python 版本: 3.10 或更高版本​
  • 操作系统: Linux、macOS​
  • 包管理器: 推荐使用uv或pip​
  • 已安装 AgentKit SDK​
Python 开发环境​
  • Python 版本:支持 3.10、3.11、3.12、3.13版本。​
  • 推荐使用requirements.txt管理依赖。​
Golang 开发环境​
  • Golang 1.24版本支持。​
  • 使用go.mod管理依赖。​
  • 适用于高性能场景。​
本地开发(Local/Hybrid 模式)​
  • Docker Desktop 或 Docker Engine 20.10+。​
  • 确保 Docker 服务已启动。​
云端部署(Cloud/Hybrid 模式)​
  • 已注册火山引擎账号。​
  • 已配置访问凭证(AK/SK),推荐使用安全的全局配置方式。​
  • ​
    # 初始化全局配置​
    agentkit config --global --init​
    ​
    # 设置访问凭证​
    agentkit config --global --set volcengine.access_key="your_access_key"​
    agentkit config --global --set volcengine.secret_key="your_secret_key"​
    ​
快速上手​
只需几分钟,即可完成您的第一个 Agent 的部署。​
​
# 1. 初始化项目 (选择 Basic App 模板)​
mkdir my-first-agent && cd my-first-agent​
agentkit init my-first-agent​
​
# 或者指定特定模板​
agentkit init my-first-agent --template basic_stream # 流式输出模板​
agentkit init my-first-agent --template a2a # A2A 协议模板​
​
# 2. 配置应用 (通过交互式向导)​
agentkit config​
​
# 3. 一键部署到云端​
agentkit launch​
​
# 4. 测试您的 Agent​
agentkit invoke "你好!"​
​
# 5. 查看运行状态​
agentkit status​
​
# 6. 清理资源(可选)​
agentkit destroy​
​
探索更多功能​
  • 初始化项目(init):查看内置模板并生成项目骨架;也支持从已有 Python Agent 文件快速包装成可部署项目。​
  • agentkit.yaml:了解生命周期配置字段,正确设置 launch_type、运行时环境变量与构建/部署参数,避免“本地可跑但云端不可用”。​
  • 使用沙箱(sandbox):创建沙箱工具/会话,执行命令、传输文件、打开 Web 预览,适合开发调试与能力验证。​
更新迭代​
AgentKit CLI 会持续发布新版本以完善命令能力、修复问题并提升稳定性。若您想查看每个版本的具体变更(例如:新增命令、参数调整、兼容性说明等),可查看 更新日志。​
最近更新时间:2026.10.29 12:23:55
这个页面对您有帮助吗?
有用
有用
无用
无用