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-агентов. Он построен вокруг файловой системы: возможности агента описываются в стандартных файлах на привычных местах, поэтому проекты агентов легко просматривать, расширять и поддерживать.
А что значит 'построен вокруг файловой системы'?Это полноценный фреймворк, а не библиотека, которую вы вызываете из кода. Сама файловая система служит интерфейсом для разработки: инструкции, инструменты и конфигурация — это обычные файлы, разложенные по стандартным папкам внутри проекта.
Как создать своего первого агента?Запустите quick start: он создаст новую папку my-agent, установит зависимости, инициализирует Git и запустит интерактивный терминальный интерфейс. Чтобы добавить eve в существующий проект, передайте ему путь к этому проекту.
Что нужно установить заранее?Node.js версии 24 или новее. Quick start сам установит зависимости сгенерированного проекта, так что больше ничего вручную настраивать не нужно.
Насколько это стабильно — можно ли уже строить на этом?Не полностью — eve находится в бете на условиях Vercel для бета-продуктов: до общего релиза могут измениться сам фреймворк, API, документация и поведение, так что стоит ожидать несовместимых изменений.
На каких AI-моделях он может работать?Модели подключаются через Vercel AI Gateway: чтобы запустить агента на модели, укажите её Gateway model ID при запуске, а для сгенерированного агента модель выбирается в файле agent/agent.ts.
Что можно добавить, когда базовый агент уже работает?Запросы с участием человека (human-in-the-loop), подагентов (subagents) и расписания — README советует наслаивать это поверх работающего агента по мере роста потребностей.
Могут ли кодинг-агенты сами читать документацию eve?Да. В npm-пакете eve поставляется вся его документация, поэтому кодинг-агенты могут читать её локально из 'node_modules/eve/docs', без того чтобы вставлять документы в промпты.
Есть ли пошаговый туториал для первого агента?Да — в документации есть туториал по созданию первого агента, который проводит вас через создание полноценного агента от начала до конца.
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 MB
Stars
5.6K
Updated
CommitOct 17Release[email protected]Oct 16
Age
4mo
Commits · 90 Days