UNPKG

eve

Version:

Filesystem-first framework for durable backend AI agents that run anywhere.

github.com/vercel/eve

vercel/eve

62 lines (39 loc) • 3.56 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
--- title: "Overview" description: "Choose a deployment strategy and prepare an eve agent for production." --- Deploy eve to Vercel or run it as a Node service on your own infrastructure. Your deployment strategy determines the build output, workflow storage, sandbox backend, and routing. The agent’s filesystem-based configuration remains portable across these strategies. ## Choose a deployment strategy Choose where the eve runtime will run: | Strategy | Build output | Workflows | Sandbox | Choose it when | | ------------------------------ | ---------------------- | ------------------------------ | ------------------------------- | ----------------------------------------------------- | | [Vercel](./vercel) | `.vercel/output` | Vercel Workflow | Vercel Sandbox | You want Vercel to operate the runtime services | | [Self-hosting](./self-hosting) | `.output/` Node server | Local or custom Workflow world | Docker, microsandbox, or custom | You operate your own Node or container infrastructure | eve is frontend agnostic and can be deployed within Next.js, Nuxt, or SvelteKit applications. See [Frontend integrations](../frontend/overview) for more details. ## Prepare for production Every production deployment must satisfy the same runtime requirements: 1. Run `eve build` to compile the agent and create host output. 2. Provide a model credential and any secrets required by tools, connections, and route authentication. 3. Replace `placeholderAuth()` with a production route policy before accepting browser traffic. 4. Select workflow and sandbox implementations that match the host. 5. Verify the health route and complete a real agent turn. `eve build` always writes compiler artifacts under `.eve/`. A Vercel build also writes `.vercel/output`. A build for another host writes the standard Nitro server under `.output/`. ## Configure credentials Keep credentials in your deployment environment or secret manager. Don’t include them in source or compiled artifacts. Your model configuration determines the required credential. A string model ID uses the [Vercel AI Gateway](https://vercel.com/docs/ai-gateway) and requires Vercel project OpenID Connect (OIDC) or `AI_GATEWAY_API_KEY`. A provider-authored model uses that provider’s package and API key. See [Agent configuration](../../agent-config#set-the-model) for both forms. Configure production route authentication separately from model access. The default policy rejects browser traffic in production. See [Auth and route protection](../auth-and-route-protection) for the available policies and secret requirements. ## Verify the deployment Check the public health route first: ```bash curl https://your_agent.example.com/eve/v1/health ``` Then connect the development terminal user interface (TUI) to the deployment and send a real message: ```bash eve dev https://your_agent.example.com ``` Set `VERCEL_AUTOMATION_BYPASS_SECRET` locally first if a Vercel deployment uses Deployment Protection. ## Continue with a platform guide Follow the guide for your deployment platform or application topology: - [Deploy to Vercel](./vercel): use Vercel Build Output, Workflow, Sandbox, Cron, and observability - [Self-host eve](./self-hosting): run the Nitro Node server with infrastructure you manage - [Frontend integrations](../frontend/overview): mount eve alongside Next.js, Nuxt, or SvelteKit