eve README

The project's README from github.com/vercel/eve. As one markdown file: README.md.

eve logo

eve

Vercel logo NPM version License Join the community on GitHub

eve is a filesystem-first framework for durable AI agents. Core agent capabilities live in conventional locations, so projects are easier to inspect, extend, and operate.

The filesystem is the authoring interface

A typical eve agent has this structure:

my-agent/
└── agent/
    ├── agent.ts            # Optional: model and runtime config
    ├── instructions.md     # Required: the always-on system prompt
    ├── tools/              # Optional: typed functions the model can call
    │   └── get_weather.ts
    ├── skills/             # Optional: procedures loaded on demand
    │   └── plan_a_trip.md
    ├── channels/           # Optional: message channels (HTTP, Slack, Discord)
    │   └── slack.ts
    └── schedules/          # Optional: recurring cron jobs
        └── weekly_recap.ts

Read the documentation for the full project layout and guides.

Quick start

npx eve@latest init my-agent

This creates a new my-agent directory, installs its dependencies, initializes Git, and starts the interactive terminal UI.

To start with another AI Gateway model, pass its model ID:

npx eve@latest init my-agent --model openai/gpt-5.6-terra

To add eve to an existing project, pass a path:

cd myapp
npx eve@latest init .

[!NOTE] The eve package includes its full documentation, so coding agents can read it locally from node_modules/eve/docs.

A minimal example

The generated project includes an agent directory. Replace agent/instructions.md with:

You are a concise weather demo assistant. Tell users that the weather data is mocked.

Add a mock weather tool at agent/tools/get_weather.ts:

import { defineTool } from "eve/tools";
import { z } from "zod";

export default defineTool({
  description: "Return mock weather data for a city.",
  inputSchema: z.object({ city: z.string().min(1) }),
  async execute({ city }) {
    return { city, condition: "Sunny", temperatureF: 72 };
  },
});

Choose the model in agent/agent.ts:

import { defineAgent } from "eve";

export default defineAgent({
  model: "openai/gpt-5.6-luna-fast",
});

For a new scaffold, start the agent again:

npm run dev

That's a working agent. Add human-in-the-loop prompts, subagents, and schedules as needed. Follow the first-agent tutorial for a complete walkthrough.

Community

The eve community lives on GitHub Discussions, where you can ask questions, share ideas, and show what you've built.

Contributing

Contributions are welcome. See CONTRIBUTING.md to get the repo running locally and land a change, and use issues and discussions to collaborate. By participating, you agree to our Code of Conduct.

Security

Please do not open public issues for security vulnerabilities. Instead, follow SECURITY.md and report responsibly to [email protected].

Beta terms

eve is currently in beta and subject to the Vercel beta terms; the framework, APIs, documentation, and behavior may change before general availability.

eve (vercel/eve)

Searching Database…

5.6K ·GitHub
Eve
这是什么？eve 是 Vercel 开源的框架，用于构建持久运行的 AI 智能体。它以文件系统为核心：agent 的各种能力都放在约定的文件位置里，因此 agent 项目易于查看、扩展和运维。
“以文件系统为核心”到底是什么意思？它是一个完整的框架，不是你在代码里调用的库。文件系统本身就是编写界面：指令、工具和配置都是普通文件，按约定的文件夹结构放在你的项目里。
我该怎么创建第一个 agent？运行快速开始：它会创建一个新的 my-agent 目录、安装依赖、初始化 Git，并启动一个交互式终端界面。如果想把 eve 加到现有项目里，传入一个路径即可。
开始之前我需要安装什么？Node.js 24 或更高版本。快速开始会自动安装生成项目的依赖，不需要你手动配置其他东西。
它现在稳定到可以基于它开发了吗？还不完全稳定——eve 目前处于 beta 阶段，受 Vercel 的 beta 条款约束：在正式发布之前，框架、API、文档和行为都可能变化，所以要做好应对破坏性变更的准备。
它可以运行在哪些 AI 模型上？模型通过 Vercel AI Gateway 来使用：启动时传入模型的 Gateway model ID 即可运行在该模型上；对于脚手架生成的 agent，则在 agent/agent.ts 里选择模型。
基本的 agent 跑起来之后，我还能加什么？人工确认环节（human-in-the-loop 提示）、子 agent 和定时任务——README 建议在能用的 agent 之上，随着需求增长逐步叠加这些功能。
编程类 agent 能自己阅读 eve 的文档吗？可以。eve 的 npm 包自带完整文档，编程类 agent 可以直接在本地从 'node_modules/eve/docs' 读取，不用你把文档粘贴到提示词里。
有没有针对第一个 agent 的分步教程？有——文档里包含一个第一个 agent 的教程，会带你从头到尾完整地构建一个 agent。
What are similar projects?deer-flow, FrontierAgent, agentscope-java, hive, ruflo, PocketFlow, flue, agentrun
Which topics is it in?agentic-framework, workflows, llm-gateway, subagents, human-in-the-loop, vercel, harness, agent-framework, sandbox, tui, agent-orchestration, agentic-ai
Creator
vercel
Size
104.7 MB
Stars
5.6K
Updated
CommitOct 15Release[email protected]Oct 15
Age
4mo
Commits · 90 Days