Skip to content

feat(cli): web-analytics --auto-install @vercel/analytics + agent integration hints#15836

Closed
brookemosby wants to merge 5 commits into
mainfrom
brooke/cli-web-analytics-auto-install
Closed

feat(cli): web-analytics --auto-install @vercel/analytics + agent integration hints#15836
brookemosby wants to merge 5 commits into
mainfrom
brooke/cli-web-analytics-auto-install

Conversation

@brookemosby
Copy link
Copy Markdown
Contributor

Summary

Adds an opt-in --auto-install flag to vercel project web-analytics:

  • After the project toggle succeeds, runs the appropriate package-manager command to add @vercel/analytics (npm install / yarn add / pnpm add / bun add), using the same scanParentDirs detection as builds.
  • With --format json, responses include packageInstall (ran/success/command/error) and integrate (summary, docs URL, Next.js App Router layout example) so agents and CI can mirror the dashboard quickstart without guessing commands.
  • Install child stdio is piped when --non-interactive (or client.nonInteractive) so automation does not require a TTY.

Usage

vercel project web-analytics --auto-install
vercel project web-analytics my-app --auto-install --format json

Tests

  • Unit tests mock the installer and cover success, JSON shape, install failure, and pipeStdio for non-interactive.

Includes a changeset for the vercel package.

Made with Cursor

- Install @vercel/analytics via detected package manager (npm/yarn/pnpm/bun)
- JSON output adds packageInstall and integrate (docs + Next.js example) for agents
- Pipe install stdio when non-interactive

Made-with: Cursor
@brookemosby brookemosby requested review from a team as code owners April 3, 2026 19:24
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 3, 2026

🦋 Changeset detected

Latest commit: f1cece2

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
vercel Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@vercel
Copy link
Copy Markdown
Contributor

vercel Bot commented Apr 3, 2026

Low Risk — CLI feature addition with new flag, utility functions, and comprehensive unit tests.

  • .changeset/cli-web-analytics-auto-install.md: new changeset for minor version bump
  • command.ts: added --auto-install flag option and usage example
  • install-vercel-web-analytics-package.ts: new utility for package manager detection and SDK installation

Assessed at f1cece2.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 3, 2026

📦 CLI Tarball Ready

The Vercel CLI tarball for this PR is now available!

Quick Test

You can test this PR's CLI directly by running:

npx https://vercel-6nr0mdij9.vercel.sh/tarballs/vercel.tgz --help

Use in vercel.json

To use this CLI version in your project builds, add to your vercel.json:

{
  "build": {
    "env": {
      "VERCEL_CLI_VERSION": "vercel@https://vercel-6nr0mdij9.vercel.sh/tarballs/vercel.tgz"
    }
  }
}

Python Runtime Wheel

A vercel-runtime wheel was also built for this PR.
To use in your Python project builds, also set this environment variable:

VERCEL_RUNTIME_PYTHON="vercel-runtime @ https://vercel-6nr0mdij9.vercel.sh/tarballs/vercel_runtime-0.13.0.dev1775679984+f1cece2-py3-none-any.whl"

Python Workers Wheel

A vercel-workers wheel was also built for this PR.
To use in your Python project builds, also set this environment variable:

VERCEL_WORKERS_PYTHON="vercel-workers @ https://vercel-6nr0mdij9.vercel.sh/tarballs/vercel_workers-0.1.0.dev1775679984+f1cece2-py3-none-any.whl"

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 3, 2026

🧪 Unit Test Strategy

Comparing: 02049a3f1cece2 (view diff)

Strategy: Affected packages only

✅ Only testing packages that have been modified or depend on modified packages.

Affected packages - 1 (3%)
  1. vercel
Unaffected packages - 39 (98%)
  1. @vercel-internals/get-package-json
  2. @vercel/backends
  3. @vercel/build-utils
  4. @vercel/cervel
  5. @vercel/cli-auth
  6. @vercel/client
  7. @vercel/config
  8. @vercel/detect-agent
  9. @vercel/edge
  10. @vercel/elysia
  11. @vercel/error-utils
  12. @vercel/express
  13. @vercel/fastify
  14. @vercel/firewall
  15. @vercel/frameworks
  16. @vercel/fs-detectors
  17. @vercel/functions
  18. @vercel/gatsby-plugin-vercel-builder
  19. @vercel/go
  20. @vercel/h3
  21. @vercel/hono
  22. @vercel/hydrogen
  23. @vercel/koa
  24. @vercel/nestjs
  25. @vercel/next
  26. @vercel/node
  27. @vercel/oidc
  28. @vercel/oidc-aws-credentials-provider
  29. @vercel/python
  30. @vercel/python-analysis
  31. @vercel/redwood
  32. @vercel/related-projects
  33. @vercel/remix-builder
  34. @vercel/routing-utils
  35. @vercel/ruby
  36. @vercel/rust
  37. @vercel/static-build
  38. @vercel/static-config
  39. examples

Results

  • Unit tests: Only affected packages will run unit tests
  • E2E tests: Running in parallel via E2E Tests workflow
  • Type checks: Only affected packages will run type checks

This comment is automatically generated based on the affected testing strategy

… flow

- Resolve scope via getScope and deep-link to project Analytics (vercel.com/d?to=...)
- Interactive: open browser after local install; non-interactive: log URL
- JSON: add agentInstallation (dashboardUrl, summary, requirementsNote)
- On local install failure, still surface agentInstallation for PR path

Made-with: Cursor
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