# eve

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

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.

## Start here

- [Getting started](https://eve.dev/docs/getting-started.md): Choose the right path for a new or existing eve project.
- [Installation](https://eve.dev/docs/installation.md): Create a project, configure a model credential, and run it locally.
- [Project structure](https://eve.dev/docs/project-structure.md): Learn which files eve discovers and how paths define capabilities.
- [First-agent tutorial](https://eve.dev/docs/tutorial/first-agent.md): Build an agent with tools, durable state, and an interface.

## Author an agent

- [Agent configuration](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.
- [Tools](https://eve.dev/docs/tools.md): Define typed actions and gate sensitive calls on human approval.
- [Skills](https://eve.dev/docs/skills.md): Add procedures that the model loads on demand.
- [Channels](https://eve.dev/docs/channels/overview.md): Expose the agent through HTTP, Slack, Discord, and other messaging surfaces.
- [Connections](https://eve.dev/docs/connections.md): Connect external MCP and OpenAPI servers without exposing credentials to the model.
- [Extensions](https://eve.dev/docs/extensions.md): Package and mount reusable eve capabilities.
- [Sandbox](https://eve.dev/docs/sandbox.md): Configure the isolated shell, filesystem, lifecycle, and network policy.
- [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.
- [Evals](https://eve.dev/docs/evals/overview.md): Define repeatable scored checks and run them with `eve eval`.

## Connect clients and interfaces

- [Base eve channel](https://eve.dev/docs/channels/eve.md): Understand the HTTP API exposed by each running eve app.
- [Frontend overview](https://eve.dev/docs/guides/frontend/overview.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.
- [TypeScript SDK](https://eve.dev/docs/guides/client/overview.md): Call an eve app from scripts, services, tests, or custom UIs.
- [Sessions, runs, and streaming](https://eve.dev/docs/concepts/sessions-runs-and-streaming.md): Understand continuation tokens, stream handles, NDJSON events, and reconnecting.
- [Authentication and route protection](https://eve.dev/docs/guides/auth-and-route-protection.md): Secure a deployed app's routes and connection OAuth.

## Run and operate

- [Execution model and durability](https://eve.dev/docs/concepts/execution-model-and-durability.md): Understand sessions, checkpointed steps, and parked work.
- [Default harness](https://eve.dev/docs/concepts/default-harness.md): Understand the built-in loop, tools, workspace, and context assembly.
- [Context control](https://eve.dev/docs/concepts/context-control.md): Control context growth, compaction, and model-visible history.
- [Security model](https://eve.dev/docs/concepts/security-model.md): Review trust boundaries, secret handling, credentials, and fail-closed behavior.
- [Deployment overview](https://eve.dev/docs/guides/deployment/overview.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.
- [Instrumentation](https://eve.dev/docs/guides/instrumentation.md): Trace agents with OpenTelemetry and inspect workflow metadata.
- [Hooks](https://eve.dev/docs/guides/hooks.md): Subscribe to runtime stream events.
- [Durable state](https://eve.dev/docs/guides/state.md): Persist per-session memory across step boundaries.
- [Dynamic capabilities](https://eve.dev/docs/guides/dynamic-capabilities.md): Resolve models, tools, skills, subagents, and instructions at runtime.
- [Remote agents](https://eve.dev/docs/guides/remote-agents.md): Call another eve deployment as a subagent.

## Reference and discovery

- [TypeScript API](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.
- [Project layout reference](https://eve.dev/docs/reference/project-layout.md): Look up authored slots and path-derived naming rules.
- [Install integrations](https://eve.dev/docs/install-integrations.md): Discover and add official or third-party integrations.
- [Documentation map](https://eve.dev/sitemap.md): Browse every documentation, integration, and template 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

- [Integrations](https://eve.dev/integrations): Browse official channels, connections, extensions, and instrumentation providers.
- [Templates](https://eve.dev/templates): Browse complete example projects and their source.
- [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.