Skip to content

AgentKit CLI 概览

AgentKit CLI 是一个为开发者设计的强大命令行工具,旨在简化和加速 Agent 应用的开发、部署和管理全生命周期。无论您是进行本地快速原型验证,还是在生产环境中进行规模化部署,agentkit 命令都能提供一致且高效的开发体验。

核心优势

  • 声明式配置:所有配置通过一个 agentkit.yaml 文件管理,清晰、可移植且易于版本控制。
  • 多环境部署:无缝支持本地开发、混合部署和纯云端部署三种模式,满足不同场景需求。
  • 一键式操作:通过 agentkit launch 等高级命令,将构建、部署等多个步骤合而为一,极大提升效率。
  • 模板化项目:内置多种应用模板,帮助您快速启动项目,无需从零开始。
  • 智能交互:提供 agentkit config 等交互式向导,引导您完成配置,降低学习成本。

主要命令

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

命令功能描述
agentkit init初始化一个新的 Agent 项目,可选择不同的模板。
agentkit config通过交互式向导配置 agentkit.yaml 文件。
agentkit build将您的 Agent 应用构建为 Docker 镜像。
agentkit deploy将已构建的镜像部署到指定环境 (本地或云端)。
agentkit launch一键完成构建和部署,是开发中最常用的命令。
agentkit invoke与已部署的 Agent 进行交互,用于快速测试。
agentkit status查看 Agent 的运行状态和 Endpoint。
agentkit destroy停止并销毁 Agent 实例,释放相关资源。

想要了解每个命令的详细用法?请查阅 命令详解

三种部署模式

AgentKit CLI 的核心特性之一是其灵活的部署模型,旨在适应从开发到生产的不同阶段。

1. 本地模式 (local)

在您的本地机器上完成构建和部署,非常适合快速开发和调试。

  • 工作流: 源代码本地 Docker 构建本地容器运行
  • 优势: 迭代速度快,支持离线工作,便于直接调试。

2. 云端模式 (cloud)

将代码的构建和部署完全托管在 AgentKit Platform 上,是生产环境的最佳实践。

  • 工作流: 源代码云端自动构建云端镜像仓库生产级 Runtime
  • 优势: 无需本地 Docker 环境,内置可观测性,环境一致性高,安全可靠。

3. 混合模式 (hybrid)

在本地构建镜像,然后将其推送到云端 AgentKit Platform 进行部署。这种模式结合了本地控制和云端能力的优点。

  • 工作流: 源代码本地 Docker 构建上传至云端镜像仓库生产级 Runtime
  • 优势: 兼顾本地构建的灵活性和云端运行环境的稳定性,适合需要自定义构建流程的场景。

配置文件 (agentkit.yaml)

agentkit.yamlAgentKit 项目的核心,它以声明式的方式定义了应用的所有配置。我们强烈建议使用 agentkit config 命令来管理此文件。

yaml
# 通用配置
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"

想要了解所有配置项的详细说明?请查阅 配置详解

快速上手

只需几分钟,即可完成您的第一个 Agent 的部署。

bash
# 1. 初始化项目 (选择 Basic App 模板)
mkdir my-first-agent && cd my-first-agent
agentkit init my-first-agent

# 2. 配置应用 (通过交互式向导)
agentkit config

# 3. 一键部署到云端
agentkit launch

# 4. 测试您的 Agent
agentkit invoke "你好!"

# 5. 查看运行状态
agentkit status

# 6. 清理资源(可选)
agentkit destroy

环境要求

✅ 基础环境(所有模式)

  • Python 3.12 或更高版本
  • pip 包管理器
  • 已安装 AgentKit SDK

🐳 本地开发(Local/Hybrid 模式)

  • Docker Desktop 或 Docker Engine 20.10+
  • 确保 Docker 服务已启动

☁️ 云端部署(Cloud/Hybrid 模式)

  • 火山引擎账号
  • 配置好 AK/SK 环境变量:
    bash
    export VOLC_ACCESSKEY="your_access_key"
    export VOLC_SECRETKEY="your_secret_key"

下一步

  • 📖 命令详解: 深入了解每个 CLI 命令的参数和用法。
  • ⚙️ 配置详解: 掌握 agentkit.yaml 的所有配置项。
  • 🚀 快速入门: 跟随端到端的教程,从零开始构建一个完整的 Agent 应用。

Released under the Apache-2.0 License.