eko

环境要求

• Node.js 运行环境与 pnpm 包管理器（README 中所有命令均基于 pnpm）
• 一个可用的大模型 API Key（Anthropic / OpenAI / Google 或 OpenAI 兼容服务）
• 浏览器或桌面自动化场景需额外安装对应平台包（@eko-ai/eko-web、@eko-ai/eko-extension 等）

安装与启动步骤

1. 1安装 Eko 包

   在 TypeScript 项目根目录执行，把 Eko 作为依赖安装到工程中；README 只给出 pnpm 这一种安装方式。

   pnpm install @eko-ai/eko

   复制

2. 2配置大模型

   在代码中声明 LLMs 对象，为每类模型填写 provider、model、apiKey；OpenAI 兼容模型需额外配置 baseURL。

   const llms: LLMs = {
     default: {
       provider: "anthropic",
       model: "claude-sonnet-4-5-20250929",
       apiKey: "your-api-key"
     }
   };

   复制

3. 3创建并运行 Agent

   实例化所需 Agent（如 BrowserAgent、FileAgent），交给 Eko 后用自然语言描述任务并 await 执行结果。

   let agents: Agent[] = [new BrowserAgent(), new FileAgent()];
   let eko = new Eko({ llms, agents });
   let result = await eko.run("Search for the latest news about Musk, summarize and save to the desktop as Musk.md");

   复制

4. 4（可选）升级到 4.0

   已有的 3.x 项目按 README 步骤更新依赖、重生成工作流，再清理 node_modules 重装并重建产物。

   pnpm up @eko-ai/eko @eko-ai/eko-nodejs @eko-ai/eko-web @eko-ai/eko-extension
   rm -rf node_modules && pnpm install

   复制

关键配置

如何确认成功

调用 eko.run() 能正常返回 result，且任务产物（如桌面上的 Musk.md）生成，即说明环境与密钥配置成功。

常见问题

注意事项

• 严禁在浏览器/前端代码中使用 API Key，应通过后端代理并配置 baseURL 与请求头。
• README 的 Quickstart 只给出简要示例，完整步骤需参阅官方文档 https://eko.fellou.ai/docs/getting-started/quickstart/。
• Eko 4.0 支持对话式交互并优化了 Agent 逻辑，同时提供暂停、恢复、中断与 task_snapshot 工作流恢复能力。
• README 中未给出 Node 版本、端口、仓库克隆等说明，相关参数请以官方配置文档为准。