Skip to content

armgit / eve

Public Imported from GitHub
0

The Open Framework for Building Agents

feat(eve): scaffold project readme (#2457)

Colton Paddendbfa01cd4b1a
diff --git a/.changeset/bright-agents-read.md b/.changeset/bright-agents-read.md
new file mode 100644
index 000000000..fec10b805
--- /dev/null
+++ b/.changeset/bright-agents-read.md
@@ -0,0 +1,5 @@
+---
+"eve": patch
+---
+
+New standalone projects created by `eve init` now include a `README.md` with templated project and development instructions.
diff --git a/docs/getting-started.mdx b/docs/getting-started.mdx
index f3c79240f..be12eee0c 100644
--- a/docs/getting-started.mdx
+++ b/docs/getting-started.mdx
@@ -75,6 +75,7 @@ A minimal agent needs `instructions.md`; `agent.ts` is optional when the default
```text
my-agent/
+├── README.md
├── package.json
├── tsconfig.json
├── agent/
diff --git a/packages/eve/src/setup/scaffold/create/project.ts b/packages/eve/src/setup/scaffold/create/project.ts
index 27669bf0b..db8d2f888 100644
--- a/packages/eve/src/setup/scaffold/create/project.ts
+++ b/packages/eve/src/setup/scaffold/create/project.ts
@@ -226,6 +226,42 @@ You are a helpful assistant.
`;
const SHARED_TEMPLATE_FILES: Record<string, string> = {
+ "README.md": `# __EVE_INIT_APP_NAME__
+
+This is an [eve](https://eve.dev) agent bootstrapped with [\`eve init\`](https://eve.dev/docs/reference/cli#eve-init).
+
+## Getting started
+
+First, run the development server:
+
+\`\`\`bash
+eve dev
+\`\`\`
+
+The development TUI opens an interactive session where you can send messages to your agent.
+
+Start by editing \`agent/instructions.md\` to define the agent's identity, purpose, tone, and response guidelines. Configure its model and runtime behavior in \`agent/agent.ts\`.
+
+Add capabilities under \`agent/\`, including tools, connections, channels, skills, subagents, and schedules. eve reloads your changes as you work.
+
+## Learn more
+
+To learn more about eve, explore these resources:
+
+- [eve documentation](https://eve.dev/docs) — learn about eve's features and authoring APIs.
+- [Build an Agent tutorial](https://eve.dev/docs/tutorial/first-agent) — build and deploy an agent step by step.
+- [eve on GitHub](https://github.com/vercel/eve) — view the source and contribute.
+
+## Deploy on Vercel
+
+Deploy your agent to [Vercel](https://vercel.com) from the project root:
+
+\`\`\`bash
+eve deploy
+\`\`\`
+
+\`eve deploy\` links a Vercel project if needed and deploys the agent to production. See the [eve deployment documentation](https://eve.dev/docs/guides/deployment/vercel) for authentication, environment variables, and deployment options.
+`,
"agent/channels/eve.ts": WEB_APP_TEMPLATE_FILES["agent/channels/eve.ts"],
"agent/instructions.md": AGENT_INSTRUCTIONS_TEMPLATE,
"tsconfig.json": `{
diff --git a/packages/eve/src/setup/scaffold/index.integration.test.ts b/packages/eve/src/setup/scaffold/index.integration.test.ts
index f21faa75f..58b1ac759 100644
--- a/packages/eve/src/setup/scaffold/index.integration.test.ts
+++ b/packages/eve/src/setup/scaffold/index.integration.test.ts
@@ -1023,6 +1023,12 @@ describe("scaffoldBaseProject", () => {
const agentSource = await readFile(join(projectRoot, "agent/agent.ts"), "utf8");
expect(agentSource).toContain('model: "openai/gpt-5-mini"');
expect(agentSource).not.toContain("modelOptions");
+ const readme = await readFile(join(projectRoot, "README.md"), "utf8");
+ expect(readme).toContain("# demo-agent");
+ expect(readme).toContain("## Getting started");
+ expect(readme).toContain("## Learn more");
+ expect(readme).toContain("## Deploy on Vercel");
+ expect(readme).not.toContain("__EVE_INIT_");
const packageJson = await readFile(join(projectRoot, "package.json"), "utf8");
expect(packageJson).toContain('"eve": "^0.25.0"');
// Channels added later (`eve add channel/slack`, possibly next to a
@@ -1107,6 +1113,7 @@ describe("scaffoldBaseProject", () => {
await expect(readFile(join(projectRoot, "package.json"), "utf8")).resolves.toContain(
'"eve": "^0.25.0"',
);
+ await expect(readFile(join(projectRoot, "README.md"), "utf8")).resolves.toContain("eve dev");
await expect(pathExists(join(projectRoot, "pnpm-workspace.yaml"))).resolves.toBe(
packageManager === "pnpm",
);
diff --git a/packages/eve/test/scenarios/eve-init.scenario.test.ts b/packages/eve/test/scenarios/eve-init.scenario.test.ts
index 0d87c62a4..27ff61b06 100644
--- a/packages/eve/test/scenarios/eve-init.scenario.test.ts
+++ b/packages/eve/test/scenarios/eve-init.scenario.test.ts
@@ -197,6 +197,13 @@ describe("eve init smoke", () => {
const projectDir = join(scratch, "smoke-agent");
const canonicalProjectDir = await realpath(projectDir);
const agentSource = await readFile(join(projectDir, "agent/agent.ts"), "utf8");
+ const readme = await readFile(join(projectDir, "README.md"), "utf8");
+ expect(readme).toContain("# smoke-agent");
+ expect(readme).toContain("## Getting started");
+ expect(readme).toContain("eve dev");
+ expect(readme).toContain("## Learn more");
+ expect(readme).toContain("## Deploy on Vercel");
+ expect(readme).toContain("eve deploy");
const packageJson = JSON.parse(await readFile(join(projectDir, "package.json"), "utf8")) as {
engines?: { node?: string };
};