2025最强ElizaOS CLI工具链入门到精通：从安装到插件开发全攻略-优快云博客

2025最强ElizaOS CLI工具链入门到精通：从安装到插件开发全攻略

【免费下载链接】eliza Autonomous agents for everyone 项目地址: https://gitcode.com/GitHub_Trending/eliz/eliza

你还在为AI Agent开发的复杂命令而头疼？还在为插件管理和TEE部署而迷茫？本文将带你一站式掌握ElizaOS CLI工具链的所有核心功能，从基础安装到高级插件开发，让你成为AI Agent开发高手。读完本文，你将能够：快速搭建ElizaOS开发环境、熟练使用各类CLI命令、开发自定义插件、部署TEE安全环境，以及掌握项目测试和发布的完整流程。

安装与环境配置

ElizaOS CLI的安装非常简单，只需使用Bun包管理器一行命令即可完成。Bun是一个快速的JavaScript运行时和包管理器，如果你还没有安装Bun，ElizaOS CLI会自动帮你安装。

bun install -g @elizaos/cli

安装完成后，你可以通过以下命令检查CLI版本：

elizaos --version

如果你希望手动控制Bun的安装，可以使用--no-auto-install标志禁用自动安装功能：

elizaos --no-auto-install create my-project

或者设置环境变量：

ELIZA_NO_AUTO_INSTALL=true elizaos create my-project

核心命令解析

ElizaOS CLI提供了丰富的命令集，涵盖了项目创建、开发、测试、部署等全生命周期管理。以下是一些最常用的核心命令：

命令	功能描述	常用选项
`elizaos create`	创建新项目、插件或Agent	`-t, --type <type>`: 指定创建类型（project, plugin, agent, tee）
`elizaos dev`	开发模式启动项目，支持自动重建和热重载	`-c, --configure`: 重新配置服务和AI模型 `--character [paths...]`: 指定Character文件路径
`elizaos start`	启动Eliza Agent，支持插件和服务配置	`-p, --port <port>`: 指定端口号 `--build`: 启动前构建项目
`elizaos test`	运行测试套件，支持组件测试和E2E测试	`-n, --name <n>`: 按名称筛选测试 `--skip-build`: 跳过构建步骤
`elizaos plugins`	插件管理，包括安装、更新、删除等	`add <plugin>`: 安装插件 `list`: 列出已安装插件 `update`: 更新插件
`elizaos publish`	发布插件到注册表	`-t, --test`: 测试发布流程 `--npm`: 仅发布到npm
`elizaos tee`	TEE环境管理，基于Phala Cloud	`phala cvms create`: 创建CVM实例 `phala docker build`: 构建Docker镜像

项目创建与开发流程

创建新项目是使用ElizaOS的第一步。根据你的需求，你可以创建不同类型的项目：

# 创建普通项目
elizaos create my-agent-project

# 创建插件项目
elizaos create my-plugin --type plugin

# 创建Agent项目
elizaos create my-assistant --type agent

# 创建TEE项目
elizaos create -t tee tee-agent

创建完成后，进入项目目录并启动开发模式：

cd my-agent-project
elizaos dev

elizaos dev命令会启动开发服务器，支持代码热重载和详细日志输出。你可以使用--character选项指定一个或多个Character文件：

# 指定多个本地Character文件
elizaos dev --character file1.json file2.json

# 使用URL加载Character
elizaos dev --character https://example.com/characters/assistant.json

插件开发实战

插件是ElizaOS生态系统的核心，它们扩展了Agent的功能，使其能够与各种外部服务和API集成。下面我们将详细介绍如何开发一个ElizaOS插件。

插件项目结构

一个标准的ElizaOS插件项目结构如下：

plugin-my-plugin/
├── src/               # 源代码目录
│   └── index.ts       # 插件主入口文件
├── images/            # 插件图片资源
│   ├── logo.jpg       # 400x400px Logo图片
│   └── banner.jpg     # 1280x640px 横幅图片
├── package.json       # 包配置文件，包含agentConfig部分
├── tsconfig.json      # TypeScript配置
└── README.md          # 插件文档

创建插件项目

使用以下命令创建一个新的插件项目：

elizaos create my-plugin --type plugin
cd plugin-my-plugin

注意，CLI会自动为插件名称添加"plugin-"前缀，确保插件命名规范一致。

插件实现示例

插件的主要逻辑在src/index.ts文件中实现。下面是一个简单的插件示例：

import { type Plugin } from '@elizaos/core';
import { z } from 'zod';

// 定义配置验证 schema
const configSchema = z.object({
  API_KEY: z.string().min(1, 'API key is required'),
});

// 导出插件对象
export const myPlugin: Plugin = {
  name: 'plugin-my-plugin',
  description: 'My custom plugin description',

  // 配置部分，映射环境变量到插件设置
  config: {
    API_KEY: process.env.MY_PLUGIN_API_KEY,
  },

  // 初始化函数
  async init(config: Record<string, string>) {
    // 验证配置
    const validatedConfig = await configSchema.parseAsync(config);

    // 插件设置
    return {
      // 插件方法和处理器
      // ...
    };
  },
};

export default myPlugin;

配置package.json

在package.json中，需要添加agentConfig部分来描述插件参数：

"agentConfig": {
  "pluginType": "elizaos:plugin:1.0.0",
  "pluginParameters": {
    "API_KEY": {
      "type": "string",
      "description": "API key for the service"
    }
  }
}

测试插件

使用以下命令运行插件测试：

elizaos test

ElizaOS支持两种类型的测试：组件测试和E2E测试。组件测试使用Bun的原生测试运行器，适合快速的单元测试；E2E测试使用ElizaOS自定义测试运行器，在真实的运行时环境中测试完整的用户场景。

发布插件

插件开发完成后，可以使用以下命令发布：

# 先登录npm
npm login

# 测试发布流程
elizaos publish --test

# 正式发布
elizaos publish

首次发布后，后续更新可以使用标准的npm和git工作流：

# 更新版本号
bun version patch|minor|major

# 发布到npm
npm publish

# 推送代码和标签
git push origin main && git push --tags

TEE安全部署

ElizaOS CLI集成了Phala Cloud CLI，提供了对可信执行环境（TEE）的无缝支持。通过TEE，你可以在安全的环境中部署和运行AI Agent，保护敏感数据和模型。

TEE项目创建与部署

首先，创建一个TEE项目：

elizaos create -t tee tee-agent
cd tee-agent

然后，登录Phala Cloud并构建Docker镜像：

# 登录Phala Cloud
elizaos tee phala auth login

# 构建Docker镜像
elizaos tee phala docker build

# 推送Docker镜像
elizaos tee phala docker push

生成Docker Compose文件并创建CVM实例：

# 生成Docker Compose文件
elizaos tee phala docker generate --template eliza

# 创建CVM实例
elizaos tee phala cvms create --name elizaos -c docker-compose.yml -e .env

部署完成后，你可以检查CVM状态：

elizaos tee phala cvms list

验证TEE证明

你可以通过以下命令获取CVM的TEE证明，确保你的应用确实运行在安全的TEE环境中：

elizaos tee phala cvms attestation <app-id>

高级功能与最佳实践

环境变量管理

ElizaOS CLI提供了便捷的环境变量管理命令：

# 列出所有环境变量
elizaos env list

# 编辑本地环境变量
elizaos env edit-local

# 重置环境变量
elizaos env reset -y

Agent管理

你可以通过以下命令管理ElizaOS Agent：

# 列出所有Agent
elizaos agent list

# 启动Agent
elizaos agent start --path my-assistant.json

# 停止所有本地Agent
elizaos agent stop --all

项目测试策略

ElizaOS推荐采用双重测试策略：

组件测试：位于src/__tests__/*.test.ts，使用Bun的测试运行器，适合快速的单元测试。
E2E测试：位于src/__tests__/e2e/*.e2e.ts，使用ElizaOS自定义测试运行器，测试完整的用户场景。

你可以使用以下命令运行特定类型的测试：

# 仅运行组件测试
elizaos test component

# 仅运行E2E测试
elizaos test e2e

# 按名称筛选测试（区分大小写）
elizaos test --name specific-test

总结与资源

通过本文的介绍，你已经掌握了ElizaOS CLI工具链的核心功能和使用方法。从项目创建到插件开发，从本地测试到TEE部署，ElizaOS CLI提供了一站式的解决方案，让AI Agent开发变得简单而高效。

官方资源

下一步学习建议

深入研究ElizaOS核心模块，了解Agent运行原理。
探索插件示例，学习如何开发复杂功能的插件。
尝试使用SQL插件，为你的Agent添加数据库操作能力。
参与ElizaOS社区，分享你的插件和项目经验。

ElizaOS CLI工具链为AI Agent开发提供了强大的支持，无论是个人开发者还是企业团队，都能从中受益。开始你的ElizaOS之旅吧，打造属于你的智能Agent！

【免费下载链接】eliza Autonomous agents for everyone 项目地址: https://gitcode.com/GitHub_Trending/eliz/eliza

创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考