@aigne/cli v1.11.6

@aigne/cli

English | 中文

AIGNE 框架的命令行工具，提供便捷的开发和管理功能。

简介

@aigne/cli 是 AIGNE 框架的官方命令行工具，旨在简化 AIGNE 应用的开发、测试和部署流程。它提供了一系列实用命令，帮助开发者快速创建项目、运行代理、测试代码，以及部署应用等。

特性

• 项目创建：快速创建新的 AIGNE 项目，包含预设的文件结构和配置
• 代理运行：轻松运行和测试 AIGNE 代理
• 测试支持：内置测试命令，方便进行单元测试和集成测试
• MCP 服务：支持将代理作为 MCP 服务器启动，与外部系统集成
• 交互式界面：美观的命令行界面，提供直观的使用体验
• 多模型支持：支持 OpenAI、Claude、XAI 等多种模型提供商

安装

使用 npm

npm install -g @aigne/cli

使用 yarn

yarn global add @aigne/cli

使用 pnpm

pnpm add -g @aigne/cli

基本命令

AIGNE CLI 提供了以下主要命令：

# 显示帮助信息
aigne --help

# 创建新项目
aigne create [path]

# 运行代理
aigne run [path]

# 运行测试
aigne test [path]

# 启动 MCP 服务器
aigne serve [path] --mcp

创建命令 (create)

创建一个带有代理配置文件的新 AIGNE 项目。

# 在当前目录创建项目（会提示输入项目名称）
aigne create

# 在指定路径创建项目
aigne create my-project

交互式创建过程会询问：

• 项目名称
• 项目模板（目前支持 default 模板）

运行命令 (run)

启动与指定代理的聊天循环。

# 运行当前目录中的代理
aigne run

# 运行指定路径中的代理
aigne run path/to/agents

# 运行远程 URL 中的代理
aigne run https://example.com/aigne-project

# 指定特定代理运行
aigne run --entry-agent myAgent

可用选项：

• --entry-agent <代理> - 指定要运行的代理名称（默认为找到的第一个代理）
• --cache-dir <目录> - 指定下载包的目录（URL模式下使用）
• --model <提供商[:模型]> - 指定AI模型，格式为'提供商[:模型]'，其中模型是可选的（如'openai'或'openai:gpt-4o-mini'）
• --verbose - 启用详细日志记录

测试命令 (test)

在指定的代理目录中运行测试。

# 测试当前目录中的代理
aigne test

# 测试指定路径中的代理
aigne test path/to/agents

服务命令 (serve)

将指定目录中的代理作为 MCP 服务器提供服务。

# 在默认端口 3000 启动 MCP 服务器
aigne serve --mcp

# 在指定端口启动 MCP 服务器
aigne serve --mcp --port 3001

# 为指定路径的代理启动 MCP 服务器
aigne serve path/to/agents --mcp

协议

Elastic-2.0