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
What is this?eve is Vercel's open-source framework for building durable AI agents. It is filesystem-first: agent capabilities live in conventional file locations, so agent projects stay easy to inspect, extend, and operate.
What does 'filesystem-first' actually mean?It is a full framework, not a library you call from code. The filesystem itself is the authoring interface: instructions, tools, and config are plain files arranged in conventional folders inside your project.
How do I create my first agent?Run the quick start: it creates a new my-agent directory, installs its dependencies, initializes Git, and launches an interactive terminal UI. To add eve to an existing project instead, pass it a path.
What do I need installed before I start?Node.js 24 or newer. The quick start installs the generated project's dependencies for you, so there is nothing else to set up by hand.
Is it stable enough to build on right now?Not fully — eve is in beta under Vercel's beta terms: the framework, APIs, documentation, and behavior may all change before general availability, so expect breaking changes.
Which AI models can it run on?Models are consumed through the Vercel AI Gateway: you run on a model by passing its Gateway model ID at start-up, and for a scaffolded agent you pick the model in agent/agent.ts.
What can I add once a basic agent is working?Human-in-the-loop prompts, subagents, and schedules — the README suggests layering these on top of a working agent as your needs grow.
Can coding agents read eve's documentation by themselves?Yes. The eve npm package ships its full documentation, so coding agents can read it locally from 'node_modules/eve/docs' without you pasting docs into prompts.
Is there a step-by-step tutorial for a first agent?Yes — the documentation includes a first-agent tutorial that walks through building a complete agent end to end.
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