eve.dev

# eve

> eve is a filesystem-first, Apache-2.0 framework for building durable backend AI agents that run on Vercel or self-hosted infrastructure.

Use this file to choose the smallest relevant documentation set. Use `/sitemap.md` for the exhaustive page map and `/llms-full.txt` only for offline indexing or a large context window. For an installed project, prefer `node_modules/eve/docs/`: those docs match the installed eve version, while eve.dev documents the latest release.

eve.dev publishes framework documentation. It is not a shared API, authorization server, MCP server, or A2A server. Every deployed eve app exposes its own `/eve/v1` routes and authentication policy. External API, OpenAPI, and MCP URLs in these docs describe third-party connections or examples unless stated otherwise.

Documentation links below point directly to Markdown. Remove the `.md` suffix for the canonical HTML page.

## Introduction

- [Getting Started](https://eve.dev/docs/getting-started.md): Create a project, configure model credentials, and run your first agent.
- [Project Structure](https://eve.dev/docs/concepts/project-structure.md): Choose a layout for agents and application code, add specialist subagents, and grow into an agent workspace.

## Core Concepts

- [Execution Model and Durability](https://eve.dev/docs/concepts/execution-model-and-durability.md): Understand sessions, checkpointed steps, and parked work.
- [Sessions, Runs, and Streaming](https://eve.dev/docs/concepts/sessions-runs-and-streaming.md): Understand session IDs, NDJSON events, controls, and reconnecting.
- [Default Harness](https://eve.dev/docs/concepts/default-harness.md): Understand model context and compaction in the built-in loop.
- [Built-in Tools](https://eve.dev/docs/concepts/built-in-tools.md): Review default tools and add opt-in tools such as Workflow, glob, grep, and sleep.
- [Context Control](https://eve.dev/docs/concepts/context-control.md): Choose what the model sees and when.
- [Security Model](https://eve.dev/docs/concepts/security-model.md): Review trust boundaries, secret handling, credentials, and fail-closed behavior.

## Build

- [Agents](https://eve.dev/docs/agent-config.md): Configure the model, reasoning effort, compaction, and runtime behavior.
- [Instructions](https://eve.dev/docs/instructions.md): Write the agent's always-on system prompt.
- [Channels](https://eve.dev/docs/channels.md): Expose the agent through HTTP, Slack, Discord, and other messaging surfaces.
- [Base eve Channel](https://eve.dev/docs/channels/eve.md): Understand the HTTP API exposed by each running eve app.
- [Skills](https://eve.dev/docs/skills.md): Add procedures that the model loads on demand.
- [Tools](https://eve.dev/docs/tools.md): Define typed actions and gate sensitive calls on human approval.
- [Connections](https://eve.dev/docs/connections.md): Connect external MCP and OpenAPI servers without exposing credentials to the model.
- [Sandbox](https://eve.dev/docs/sandbox.md): Configure the isolated shell, filesystem, lifecycle, and network policy.
- [Memory](https://eve.dev/docs/memory.md): Give an agent cross-session context through eve-managed slots backed by Supermemory, the built-in file provider, or your own provider.
- [File Memory](https://eve.dev/docs/memory/file.md): Configure the built-in bounded document provider and its storage backends.
- [Build a Memory Provider](https://eve.dev/docs/memory/custom-provider.md): Implement the recall, capture, and tools contract for any store or memory service.
- [Subagents](https://eve.dev/docs/subagents.md): Delegate work to copies of the root agent or declared specialists.
- [Schedules](https://eve.dev/docs/schedules.md): Run prompts or handlers on a cron cadence.
- [Hooks](https://eve.dev/docs/guides/hooks.md): Subscribe to runtime stream events.
- [Dynamic Capabilities](https://eve.dev/docs/guides/dynamic-capabilities.md): Resolve models, tools, skills, subagents, and instructions at runtime.
- [Evals](https://eve.dev/docs/evals.md): Define repeatable scored checks and run them with `eve eval`.
- [Durable State](https://eve.dev/docs/concepts/state.md): Persist per-session memory across step boundaries.
- [Session Context](https://eve.dev/docs/guides/session-context.md): Use session metadata and runtime accessors in authored code.

## Integrate

- [Add Integrations](https://eve.dev/docs/install-integrations.md): Discover and add official or third-party integrations.
- [Extensions](https://eve.dev/docs/extensions.md): Package and mount reusable eve capabilities.
- [Remote Agents](https://eve.dev/docs/guides/remote-agents.md): Call another eve deployment as a subagent.
- [Agent Client Protocol (ACP)](https://eve.dev/docs/protocols/acp.md): Use local or deployed eve agents from ACP clients.
- [Universal Commerce Protocol (UCP)](https://eve.dev/docs/protocols/ucp.md): Serve a UCP profile from a custom eve channel.
- [Frontend Frameworks](https://eve.dev/docs/guides/frontend.md): Build browser chat interfaces with `useEveAgent`.
- [Next.js](https://eve.dev/docs/guides/frontend/nextjs.md): Mount eve routes and use the React client in Next.js.
- [Nuxt](https://eve.dev/docs/guides/frontend/nuxt.md): Mount eve routes and use the Vue client in Nuxt.
- [SvelteKit](https://eve.dev/docs/guides/frontend/sveltekit.md): Mount eve routes and use the Svelte client in SvelteKit.
- [TanStack Start](https://eve.dev/docs/guides/frontend/tanstack.md): Mount eve routes and use the React client in TanStack Start.
- [Client SDK](https://eve.dev/docs/guides/client.md): Call an eve app from scripts, services, tests, or custom UIs.

## Operate

- [Deployment](https://eve.dev/docs/guides/deployment.md): Choose between Vercel and self-hosted infrastructure.
- [Deploy to Vercel](https://eve.dev/docs/guides/deployment/vercel.md): Build and deploy with Vercel Workflow and Vercel Sandbox.
- [Self-Hosting](https://eve.dev/docs/guides/deployment/self-hosting.md): Run eve as a Node service or container.
- [Workflow Worlds](https://eve.dev/docs/guides/deployment/workflow-worlds.md): Choose the local, Postgres, or another Workflow world for self-hosted sessions.
- [Self-Hosted Operations](https://eve.dev/docs/guides/deployment/self-hosted-operations.md): Upgrade, scale, and troubleshoot a self-hosted agent.
- [Authentication](https://eve.dev/docs/guides/auth-and-route-protection.md): Secure an agent's HTTP routes and establish caller identity.
- [Instrumentation](https://eve.dev/docs/observability/instrumentation.md): Configure lifecycle instrumentation and OpenTelemetry destinations.
- [Terminal UI](https://eve.dev/docs/guides/dev-tui.md): Work with a local or deployed agent from the interactive terminal UI.

## Patterns

- [Multi-Tenant Memory](https://eve.dev/docs/patterns/multi-tenant-memory.md): Scope any memory provider to an authenticated tenant and caller.
- [Dynamic Scheduling](https://eve.dev/docs/patterns/dynamic-scheduling.md): Build application-managed schedules from an eve schedule and authored tools.
- [Multi-Tenant Outbound Auth](https://eve.dev/docs/patterns/multi-tenant-auth.md): Select tenant-scoped credentials for tools and connections.
- [Multi-Tenant Approvals](https://eve.dev/docs/patterns/multi-tenant-approvals.md): Apply tenant policy to authored and connection tools.

## Experimental

- [Dynamic Schedules](https://eve.dev/docs/experimental/dynamic-schedules.md): Create and manage creator-owned runtime schedules with the experimental API; includes updates, approvals, and local delivery.

## API Reference and Discovery

- [Agent Files](https://eve.dev/docs/reference/agent-files.md): Look up filesystem slots, path-derived names, and discovery rules.
- [TypeScript API Reference](https://eve.dev/docs/reference/typescript-api.md): Find public `define*` helpers, runtime context, and import paths.
- [CLI Reference](https://eve.dev/docs/reference/cli.md): Find every eve command and option.
- [Responsible Use](https://eve.dev/docs/responsible-use.md): Review deployer responsibilities and safeguards.
- [Documentation Map](https://eve.dev/sitemap.md): Browse every documentation and integration page with type and summary metadata.
- [Agent Instructions](https://eve.dev/agents.md): Read operational guidance for coding agents working with eve.
- [Full Documentation Corpus](https://eve.dev/llms-full.txt): Load all docs and integration content for offline indexing or a large context window.

## Optional

- [Changelog](https://eve.dev/changelog.md): Read eve release notes, including breaking changes and fixes. Follow the next-page links for older releases.
- [Integrations](https://eve.dev/integrations): Browse official channels, connections, extensions, and observability integrations.
- [Templates](https://vercel.com/templates/eve): Browse eve example projects on Vercel.
- [Official eve Skill](https://github.com/vercel/eve/blob/main/skills/eve/SKILL.md): Install or inspect the coding-agent skill; its guidance defers to version-matched bundled docs.
- [Source Repository](https://github.com/vercel/eve): Read source, releases, issues, and contribution guidance.