TheDocumentation Index
Fetch the complete documentation index at: https://mintlify.com/vercel/eve/llms.txt
Use this file to discover all available pages before exploring further.
eve binary runs from your app root. Every command first loads .env and .env.local from that root before doing anything else. Running eve with no command is equivalent to running eve dev.
Commands at a glance
| Command | Description |
|---|---|
eve init [target] | Scaffold a new agent, or add one to an existing project directory |
eve info | Print the resolved application: discovered tools, skills, subagents, schedules, channels, routes, artifact paths, and discovery diagnostics |
eve build | Compile .eve/ artifacts and build the host output; prints the output directory |
eve start | Serve the previously built .output/ app; prints the listening URL |
eve dev | Start the local dev server and open the terminal UI |
eve dev <url> | Connect the terminal UI to an existing server URL instead of booting a local server |
eve link | Link the directory to a Vercel project and pull AI Gateway credentials |
eve deploy | Deploy the agent to Vercel production (links first if needed) |
eve eval | Run evals against the local app or a remote target |
eve channels add [kind] | Scaffold a channel interactively, or by kind (slack | web) |
eve channels list | List user-authored channels in the current project |
eve init
target controls the scaffolding mode:
- A name (
eve init my-agent) scaffolds a fresh project in a newmy-agent/directory, installs dependencies, and initializes Git. - An existing directory (
eve init .) adds an agent to that project. Requires apackage.json;agent/files must not exist yet. Addseve,ai, andzoddependencies without touching anything else. - No target scaffolds or updates the current directory, same as
eve init .. Exception: when running inside a coding agent CLI (Claude Code, Cursor, Codex, etc.), a bareeve initprints a setup guide instead of scaffolding.
claude, codex, cursor-agent, droid, gemini, opencode, or pi) is on PATH, eve init offers available REPLs and eve dev (the default). Each REPL receives a project-specific prompt.
Add the Web Chat application (a Next.js app) to the fresh project. Rejected when adding to an existing project — run
eve channels add web there instead.eve info
Emit output as JSON instead of formatted text.
eve build
.eve/ artifacts and builds the host output, then prints the built output path. No flags.
When eve build fails on discovery errors, it prints the full diagnostics report (severity, message, source path) and the diagnostics artifact path.
Artifacts written under .eve/
These artifacts are preserved even on partial failure and are useful for debugging:
| Artifact | Description |
|---|---|
.eve/discovery/agent-discovery-manifest.json | What eve found on disk |
.eve/discovery/diagnostics.json | Authored-shape errors and warnings |
.eve/compile/compiled-agent-manifest.json | The serialized authored surface eve loads at runtime |
.eve/compile/compile-metadata.json | Build-time metadata and paths |
.eve/compile/module-map.mjs | Compiled module entrypoints eve imports at runtime |
eve start
Host interface to bind. Defaults to all interfaces.
Port to listen on. Defaults to
$PORT, then 3000.eve dev
Host interface to bind. Defaults to all interfaces.
Port to listen on. Defaults to
$PORT, then 3000.Connect to an existing server URL instead of starting one.
Start the server without an interactive terminal UI. Use this for headless verification and CI.
Title shown in the terminal UI. Defaults to the app folder name.
Pre-fill the prompt input after launching the UI (editable, not auto-submitted).
Tool-call rendering mode:
full | collapsed | auto-collapsed | hidden. Default: auto-collapsed.Reasoning rendering mode:
full | collapsed | auto-collapsed | hidden. Default: full.Subagent-section rendering mode:
full | collapsed | auto-collapsed | hidden. Default: auto-collapsed.Connection-authorization rendering mode:
full | collapsed | auto-collapsed | hidden. Default: full.Assistant header statistic:
tokens | tokensPerSecond. Default: tokensPerSecond.Model context window size in tokens, shown as a usage percentage in the UI.
Server/agent log streams to show:
all | stderr | sandbox | none. Default: stderr.Local dev writes the active server process ID to
.eve/dev-process.pid. If another eve dev starts for the same agent while that process is still running, eve exits with a message that includes the command to stop the existing server.eve link
.env.local. You select a team and then one of its projects; type a name and choose Search for ‘<name>’ to search further.
Running eve link again re-links: the pickers always run and the new choice wins. This command is interactive only — in CI, use vercel link --project <name> --yes --non-interactive instead.
A running eve dev reloads env files automatically after linking; no restart is needed.
eve deploy
vercel deploy --prod), installing dependencies first and pulling environment variables after. An already-linked project deploys with or without a TTY. An unlinked directory walks the eve link pickers when a terminal is present, and exits with guidance otherwise.
eve eval
eve eval weather runs everything under evals/weather/.
Exit codes:
0— every eval passed its checks1— any eval failed (failed check, execution error, or--strictthreshold miss)2— configuration errors
Remote agent URL to target. Skips local host startup.
Run only evals carrying a specific tag. Repeatable.
Below-threshold scores also fail the exit code.
Print discovered evals without running them.
Per-eval timeout in milliseconds.
Maximum number of concurrent eval executions. Default:
8.Output results as JSON.
Write JUnit XML results to the specified file path.
Skip eval-defined reporters (e.g. Braintrust).
Stream per-eval
t.log lines to stdout.eve channels add
agent/channels/. With no kind argument, prompts interactively. Pass a kind to scaffold directly: slack or web.
Channel kind to scaffold:
slack | web. Omit to choose interactively.Overwrite existing channel files.
Assume yes for confirmations. Requires an explicit
kind.eve channels list
Output as JSON.
Recommended development loop
Project Layout
What eve info discovers on disk
TypeScript API
define* helpers and import paths