Skip to content

feat(eve): add workspace-aware doctor command - #3354

Open
OwenKephart wants to merge 2 commits into
mainfrom
doctor-workspace-readiness
Open

OwenKephart wants to merge 2 commits into
mainfrom
doctor-workspace-readiness

Conversation

@OwenKephart

Copy link
Copy Markdown
Contributor

Summary

Projects need a fast way to distinguish local setup problems from Vercel readiness problems, including when they contain multiple independently addressed agents. Add eve doctor as a read-only diagnostic command. It checks Node.js, project discovery, package state, Git, and bounded non-interactive Vercel authentication; workspace-root invocations report shared checks and every discovered member, while member invocations limit agent diagnostics to that member. --offline skips the Vercel probe, and network uncertainty remains an unknown result rather than a false login failure.

Validation

  • pnpm fmt
  • pnpm lint (passes with existing warnings outside this change)
  • pnpm --filter eve typecheck
  • pnpm --filter eve exec vitest run --config vitest.unit.config.ts src/cli/run.test.ts src/cli/commands/doctor.test.ts src/doctor/policies.test.ts
  • pnpm docs:check
  • Attempted pnpm --filter eve exec vitest run --config vitest.integration.config.ts src/doctor/doctor.integration.test.ts; the integration config cannot load because the existing #internal/workflow-bundle/workflow-builders.js package import is not defined, including after pnpm --filter eve build:compiled.

Checklist

  • This change was requested or approved by a maintainer
  • I ran the relevant checks from CONTRIBUTING.md
  • I added tests and documentation where relevant
  • I added a changeset if this touches the published eve package
  • DCO sign-off passes for every commit (git commit --signoff)

Signed-off-by: owenkephart <owen.kephart@vercel.com>
@vercel

vercel Bot commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
eve-docs Ready Ready Preview, v0 Sep 14, 2026 11:55pm UTC
eve-docs-4759 Ready Ready Preview, v0 Sep 14, 2026 11:55pm UTC
eve-pkg Ready Ready Preview, v0 Sep 14, 2026 11:55pm UTC

@github-actions

github-actions Bot commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

Bundle + Package Summary: apps/fixtures/weather-agent

Key takeaways

  • No notable deltas vs main (15c7a2e).

Delta vs main (15c7a2e)

Area Metric Baseline Current Delta
Package Packed tarball 8.75 MB 8.76 MB +11.1 kB ⚠️
Package Unpacked publish size 32.92 MB 32.97 MB +54.5 kB ⚠️
Package Installed footprint 78.54 MB 78.59 MB +54.5 kB ⚠️
Package Published files 3989 4007 +18
Package Installed files 7911 7929 +18
Package Installed package instances 33 33 0
Package Distinct installed package names 32 32 0
Package Installed dependency edges 51 51 0
Package Installed optional peer edges 8 8 0
Runtime Unique function payloads 2 2 0
Runtime Total function bytes 20.70 MB 20.72 MB +14.7 kB ⚠️
Runtime Public routes 18 18 0
Changed function payloads vs main (15c7a2e) (2)
Function Status Baseline Current Delta Route changes
functions/__server.func changed 10.35 MB 10.36 MB +7.3 kB ⚠️ none
functions/.well-known/workflow/v1/flow.func changed 10.35 MB 10.36 MB +7.3 kB ⚠️ none

eve init install

Metric Baseline Current Delta
Installed footprint 116.63 MB 116.69 MB +54.5 kB ⚠️
Installed packages 113 113 0
dependencies 4 4 0
devDependencies 2 2 0
Dependency package bytes 49.17 MB 49.22 MB +54.5 kB ⚠️
devDependency package bytes 5.04 MB 5.04 MB 0 B ➖
eve init dependency changes vs main (15c7a2e)

dependencies

  • Changed: eve@file:eve-0.54.5.tgz -> eve@file:eve-0.55.0.tgz
Build Metadata
  • Preset: vercel
  • Nitro: nitro@3.0.260903-beta
  • Output directory: apps/fixtures/weather-agent/.vercel/output
  • Build metadata timestamp: 2026-09-14T23:56:03.137Z
  • Route aliases: 18 public, 1 internal (19 total aliases)
  • Vercel routes in config: 21
  • Severity legend: 🔴 dominant/large, 🟠 notable, 🟡 watch, ⚪ small
Package Drill-Down

Package Details

  • Package: eve@0.55.0
  • Package directory: packages/eve
  • Tarball: 8.76 MB (eve-0.55.0.tgz)
  • Unpacked payload: 32.97 MB across 4007 published files
  • Installed footprint: 78.59 MB across 7929 installed files
  • Installed root package: 31.54 MB
  • Installed dependencies: 47.05 MB
  • Installed package instances: 33
  • Distinct installed package names: 32
  • Installed dependency edges: 51
  • Installed optional peer edges: 8
  • Runtime dependencies: 2
  • Peer dependencies: 6 (5 optional)

Installed footprint is measured from an isolated temporary npm install of the packed tarball.
Graph metrics read only package.json files in package directories directly beneath a node_modules boundary, including nested boundaries. Each directory is one package instance; distinct names come from those manifests. Dependency edges count each unique name in dependencies or optionalDependencies per instance; optional peer edges count peerDependencies marked optional.

Heavy installed dependencies

  • eve: 31.54 MB (40.1%)
  • @rolldown/binding-linux-x64-gnu: 19.31 MB (24.6%)
  • ai: 7.14 MB (9.1%)
  • zod: 6.76 MB (8.6%)
  • undici: 3.51 MB (4.5%)
Publish payload breakdown
Published file size
🔴 dist/src/compiled/shadcn-registry/index.js       [#############...........] 9.76 MB 29.6%
🟠 dist/src/compiled/@photon-ai/chat-adapter-ime... [###.....................] 2.27 MB 6.9%
🟠 dist/src/compiled/@ai-sdk/code-mode/index.js     [#.......................] 1.03 MB 3.1%
🟡 dist/src/compiled/@vercel/blob/index.js          [#.......................] 901.4 kB 2.7%
🟡 dist/src/compiled/_chunks/workflow/signal-exi... [#.......................] 514.6 kB 1.6%
🔴 Other published files                            [########################] 18.50 MB 56.1%
Installed footprint breakdown
Installed package size
🔴 eve                             [########################] 31.54 MB 40.1%
🔴 @rolldown/binding-linux-x64-gnu [###############.........] 19.31 MB 24.6%
🔴 ai                              [#####...................] 7.14 MB 9.1%
🔴 zod                             [#####...................] 6.76 MB 8.6%
🟠 undici                          [###.....................] 3.51 MB 4.5%
🟠 nitro                           [#.......................] 1.89 MB 2.4%
🔴 Other installed packages        [######..................] 8.44 MB 10.7%
Runtime dependencies (2)
Package Range Notes
nitro 3.0.260903-beta
undici 8.9.0
Peer dependencies (6)
Package Range Notes
@opentelemetry/api ^1.0.0 optional peer
ai catalog:
braintrust ^3.0.0 optional peer
dd-trace ^6.13.0 optional peer
just-bash ^3.1.0 optional peer
microsandbox ^0.5.0 optional peer
eve init install drill-down

eve init install details

  • Command: eve init my-agent
  • Package manager: npm
  • Installed footprint: 116.69 MB across 9813 installed files
  • Installed packages: 113 total (107 transitive-only)
  • dependencies: 4 direct packages totaling 49.22 MB
  • devDependencies: 2 direct packages totaling 5.04 MB
  • Other transitive package files: 62.43 MB

Installed footprint is measured from an isolated temporary eve init my-agent using the current packed eve tarball.

Heavy installed dependencies

  • eve: 31.54 MB (27.0%)
  • @typescript/typescript-linux-x64: 27.95 MB (23.9%)
  • @rolldown/binding-linux-x64-gnu: 19.31 MB (16.5%)
  • zod: 10.37 MB (8.9%)
  • ai: 7.14 MB (6.1%)
Installed footprint breakdown
Installed package size
🔴 eve                              [########################] 31.54 MB 27.0%
🔴 @typescript/typescript-linux-x64 [#####################...] 27.95 MB 23.9%
🔴 @rolldown/binding-linux-x64-gnu  [###############.........] 19.31 MB 16.5%
🔴 zod                              [########................] 10.37 MB 8.9%
🔴 ai                               [#####...................] 7.14 MB 6.1%
🟠 undici                           [###.....................] 3.51 MB 3.0%
🔴 Other installed packages         [#############...........] 16.87 MB 14.5%
dependencies (4)
Package Range Installed size Share
@vercel/connect 1.0.0 167.9 kB 0.1%
ai ^7.0.93 7.14 MB 6.1%
eve file:eve-0.55.0.tgz 31.54 MB 27.0%
zod 4.5.4 10.37 MB 8.9%
devDependencies (2)
Package Range Installed size Share
@types/node 24.x 2.54 MB 2.2%
typescript 7.0.2 2.50 MB 2.1%
Function Drill-Down

Payload Size Graph

Unique function payload size and share of total
🔴 functions/.well-known/workflow/v1/flow.func     [########################] 10.36 MB 50.0%
🔴 functions/__server.func                         [########################] 10.36 MB 50.0%

Top Function Payloads

🟠 functions/.well-known/workflow/v1/flow.func • 1 public route • 10.36 MB
Metric Value
Public routes /.well-known/workflow/v1/flow
Runtime nodejs24.x
Handler index.mjs
Payload 10.36 MB
Function files 10.36 MB across 115 files
Traced dependencies 0 B
Signal 🟠 Bundled file index.mjs is 2.24 MB (21.6%)

🟠 🔎 Dependency Analysis

📦 Bundled files:

Bundled file size
🟠 index.mjs                        [###########.............] 2.24 MB 21.6%
🟡 _libs/undici.mjs                 [#####...................] 980.8 kB 9.5%
🟡 _chunks/esm-Fqlolk7e.mjs         [###.....................] 723.3 kB 7.0%
🟡 _chunks/chatgpt-model.mjs        [###.....................] 699.7 kB 6.8%
🟡 _chunks/signal-exit-Dsy-TT0V.mjs [###.....................] 616.2 kB 5.9%
🔴 Other bundled files              [########################] 5.10 MB 49.2%

🧾 Vercel Config

{
  "handler": "index.mjs",
  "launcherType": "Nodejs",
  "shouldAddHelpers": false,
  "supportsResponseStreaming": true,
  "runtime": "nodejs24.x",
  "maxDuration": "max",
  "experimentalTriggers": [
    {
      "type": "queue/v2beta",
      "topic": "__eve776561746865722d6167656e74_wkf_workflow_*",
      "consumer": "default",
      "retryAfterSeconds": 5,
      "initialDelaySeconds": 0
    }
  ],
  "environment": {
    "WORKFLOW_PRECONDITION_GUARD": "1"
  }
}

🟠 functions/__server.func • 17 public routes, 1 internal alias • 10.36 MB
Metric Value
Public routes /
/.well-known/workflow/v1/webhook/[token]
/eve/v1/activity/[token]
/eve/v1/callback/[token]
/eve/v1/connections/[name]/callback/[attemptId]/[token]
/eve/v1/connections/[name]/callback/[token]
/eve/v1/health
/eve/v1/info
/eve/v1/session
/eve/v1/session/[parentSessionId]/subagents/[callId]/[childSessionId]/stream
/eve/v1/session/[sessionId]
/eve/v1/session/[sessionId]/cancel
/eve/v1/session/[sessionId]/clear
/eve/v1/session/[sessionId]/compact
/eve/v1/session/[sessionId]/reset
/eve/v1/session/[sessionId]/stream
/eve/v1/task-input/[token]
Internal aliases /__server
Runtime nodejs24.x
Handler index.mjs
Payload 10.36 MB
Function files 10.36 MB across 115 files
Traced dependencies 0 B
Signal 🟠 Bundled file index.mjs is 2.24 MB (21.6%)

🟠 🔎 Dependency Analysis

📦 Bundled files:

Bundled file size
🟠 index.mjs                        [###########.............] 2.24 MB 21.6%
🟡 _libs/undici.mjs                 [#####...................] 980.8 kB 9.5%
🟡 _chunks/esm-Fqlolk7e.mjs         [###.....................] 723.3 kB 7.0%
🟡 _chunks/chatgpt-model.mjs        [###.....................] 699.7 kB 6.8%
🟡 _chunks/signal-exit-Dsy-TT0V.mjs [###.....................] 616.2 kB 5.9%
🔴 Other bundled files              [########################] 5.10 MB 49.2%

🧾 Vercel Config

{
  "handler": "index.mjs",
  "launcherType": "Nodejs",
  "shouldAddHelpers": false,
  "supportsResponseStreaming": true,
  "runtime": "nodejs24.x"
}

Build Timing: e2e/fixtures/agent-tools-sandbox

This is an informational timing measurement inside eve build, from preflight through publication. Output-size measurement and profile writing are excluded.

Build mode: deployable Vercel build with sandbox template prewarm included.

  • Build pipeline: 4.52 s -> 4.53 s (+3.2 ms) vs main (15c7a2e).
  • Timing is informational: shared GitHub runners are too variable for a hard timing budget.
Detailed phase timings vs `main (15c7a2e)`
Phase Baseline Current Delta
extension.check 0.9 ms 0.9 ms 0.0 ms
project.resolve 0.3 ms 0.2 ms -0.1 ms
workspace.create 0.5 ms 0.4 ms -0.1 ms
host.prepare 508.6 ms 422.7 ms -85.9 ms
vercel.service-prefix.resolve 1.5 ms 1.6 ms +0.1 ms
nitro.create 412.6 ms 436.4 ms +23.8 ms
sandbox.prewarm 276.1 ms 297.2 ms +21.1 ms
nitro.cache.prepare 0.2 ms 0.3 ms +0.1 ms
nitro.prepare 0.8 ms 1.6 ms +0.8 ms
nitro.public-assets 0.6 ms 0.6 ms 0.0 ms
nitro.prerender 0.3 ms 0.3 ms 0.0 ms
nitro.bundle 3.24 s 3.24 s +4.6 ms
nitro.cache.write 0.3 ms 0.2 ms -0.1 ms
vercel.workflow-function.materialize 67.3 ms 114.8 ms +47.5 ms
agent-summary.emit 0.7 ms 0.7 ms 0.0 ms
nitro.close 0.1 ms 0.1 ms 0.0 ms
output.publish 11.5 ms 3.1 ms -8.4 ms
workspace.remove 1.8 ms 1.7 ms -0.1 ms

Comment thread packages/eve/src/cli/run.ts Outdated
registerRegistryCommands({ program, logger, applicationContext });

program
.command("doctor [path]")

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[P1] Keep run.ts under the enforced file-size limit. This registration raises the file from 698 to 708 lines, and the current test-unit check fails because production sources may not exceed 700 lines. Extract the doctor registration into a focused command-registration module, or otherwise bring this file below the cap without adding it to the debt allowlist.

Comment thread packages/eve/src/doctor/collectors.ts Outdated
): Promise<VercelFacts> {
if (offline) return { kind: "skipped" };
try {
return { kind: await getVercelAuthStatus(workspaceRoot) };

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[P1] Do not execute a Vercel binary selected from the inspected target. getVercelAuthStatus(workspaceRoot) reaches resolveVercelInvocation, which prefers <workspaceRoot>/node_modules/.bin/vercel and spawns it with the caller's environment. Running eve doctor /untrusted/project can therefore execute target-controlled code with the caller's credentials. I verified that an executable shim under a temporary target is selected. Use a trusted CLI path for this diagnostic, or require explicit trust before running the probe.

Comment thread packages/eve/src/doctor/collectors.ts Outdated
) {
return { kind: "not-applicable" };
}
await access(join(appRoot, "node_modules"));

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[P1] A node_modules directory is neither sufficient nor necessary evidence that dependencies are installed. An empty or stale directory returns installed, while a Yarn 4 Plug'n'Play project with .pnp.cjs returns missing and exits nonzero. I reproduced both outcomes. Make this check package-manager-aware and verify the declared dependency layout instead of using one directory as the readiness signal.

Comment thread packages/eve/src/doctor/doctor.ts Outdated
];

if (context === undefined || root === undefined) {
diagnostics.push(discoveryDiagnostic(await collectDiscoveryFacts(resolvedPath)));

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[P1] Preserve the error from findEveProjectContext() instead of falling back to the layout-only resolver after it throws. A project with agent/ and invalid package.json JSON throws in the context resolver, but resolveDiscoveryProject() accepts the package-file marker and this path reports discovery as passing. I reproduced a 0-failure summary for that invalid project. Retain the caught error as the failed discovery diagnostic, or use the fallback only when context resolution returns no project.

summary: "Vercel CLI is not installed.",
remediation: [{ kind: "command", command: "npm i -g vercel@latest" }],
};
case "unavailable":

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[P1] The current Vercel CLI's normal unauthenticated response reaches this branch. Vercel 59.5.0 prints Logged out., but isLoggedOutFailure() does not match that phrase, so getVercelAuthStatus() returns unavailable and doctor reports an unknown network-style result without vercel login remediation. Add this response to the shared classifier with a regression test, or use structured CLI output.

Comment thread packages/eve/src/doctor/render.ts Outdated

function renderDiagnostic(theme: CliTheme, diagnostic: Diagnostic): string[] {
return [
`${statusText(theme, diagnostic.status, SYMBOLS[diagnostic.status])} ${diagnostic.summary}`,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[P2] Sanitize fact-derived text before writing the human report. Discovery errors and successful summaries include caller-controlled filesystem paths, and POSIX path components can contain terminal control sequences. I verified that an OSC sequence in diagnostic.summary survives this renderer. Use the existing sanitizeForTerminal() for summaries, remediation text, and headings before applying the theme, while preserving raw values in JSON output.

Comment thread packages/eve/src/doctor/collectors.ts Outdated
manager: manager.kind,
source: manager.source,
lockfiles,
conflict: managers.size > 1,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[P2] Compare observed lockfile managers with the selected manager, not only with each other. For example, { "packageManager": "pnpm@11" } plus only package-lock.json selects pnpm but leaves managers.size === 1, so this reports conflict: false. I reproduced that result. Warn whenever an observed lockfile belongs to a manager other than the selected one.

Comment thread packages/eve/src/doctor/policies.ts Outdated
return {
id: "package.manager",
status: "pass",
summary: `Selected ${facts.manager} as the package manager (${facts.source}).`,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[P2] Map PackageManagerSource to user-facing copy rather than exposing the internal enum. The current report renders text such as Selected pnpm as the package manager (package-manager-field). Use wording such as from the packageManager field in package.json, from a lockfile, or by default.

Comment thread docs/reference/cli.md Outdated
eve doctor [path] [--offline] [--json]
```

Runs read-only checks for the current project or a supplied path. It checks the active Node.js version, eve project discovery, package-manager selection and conflicting lockfiles, dependency installation, Vercel CLI authentication, and Git state. The default Vercel check runs a bounded, non-interactive `vercel whoami` probe. It never opens a browser, logs in, changes files, installs packages, or evaluates authored code.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[P2] Scope the no-mutation promise to project files. doctor participates in the normal CLI telemetry lifecycle, which can persist an identity in the eve config directory and start the telemetry uploader even with --offline; that option only skips the Vercel probe. Replace the absolute never ... changes files wording with the checks do not change project files, and make the same distinction for local-only checks in the changeset.

Signed-off-by: owenkephart <owen.kephart@vercel.com>
return new Promise<T>((resolvePromise) => {
const cwd = existingDir(options.cwd);
const invocation = resolveVercelInvocation(cwd, commandArgs(args, options.nonInteractive));
const invocation = options.trustedCli

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The trustedCli invocation path in runVercelProcess omits shell: true on Windows, so spawn("vercel") fails with ENOENT against the vercel.cmd/vercel.exe PATH shim.

Fix on Vercel

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant