vercel-optimize

Files (156)

• AGENTS.md
• CONTRIBUTING.md
• README.md
• SKILL.md
• auth-route.mjs · lib/
• budget-summary.mjs · lib/
• citations.mjs · lib/
• cost-coverage.mjs · lib/
• dedup-recs.mjs · lib/
• deep-dive.mjs · lib/
• display-labels.mjs · lib/
• extract-claims.mjs · lib/
• framework-support.mjs · lib/
• build-minutes-fanout.mjs · lib/gates/
• cold-start.mjs · lib/gates/
• contract.mjs · lib/gates/
• cwv-poor.mjs · lib/gates/
• external-api-slow.mjs · lib/gates/
• hard-gates.mjs · lib/gates/
• index.mjs · lib/gates/
• isr-overrevalidation.mjs · lib/gates/
• middleware-heavy.mjs · lib/gates/
• observability-events-attribution.mjs · lib/gates/
• platform-bot-protection.mjs · lib/gates/
• platform-fluid-compute.mjs · lib/gates/
• region-misconfig.mjs · lib/gates/
• route-errors.mjs · lib/gates/
• scanner-driven.mjs · lib/gates/
• select-candidates.mjs · lib/gates/
• slow-route.mjs · lib/gates/
• types.d.ts · lib/gates/
• uncached-route.mjs · lib/gates/
• usage-spike-triage.mjs · lib/gates/
• grade-recommendation.mjs · lib/
• impact-label.mjs · lib/
• impact-magnitude.mjs · lib/
• investigation-brief.mjs · lib/
• observation-safety.mjs · lib/
• project-facts.mjs · lib/
• queries.mjs · lib/
• reconcile-candidates.mjs · lib/
• render-report.mjs · lib/
• repo-root.mjs · lib/
• route-normalize.mjs · lib/
• bot-protection-certainty.mjs · lib/sanitizers/
• cache-tag-invalidation-certainty.mjs · lib/sanitizers/
• count-correct.mjs · lib/sanitizers/
• function-duration-invocations.mjs · lib/sanitizers/
• index.mjs · lib/sanitizers/
• middleware-conflict.mjs · lib/sanitizers/
• missing-citation.mjs · lib/sanitizers/
• pre-release.mjs · lib/sanitizers/
• rate-limit.mjs · lib/sanitizers/
• rendering-mode-mislabel.mjs · lib/sanitizers/
• undeclared-dep.mjs · lib/sanitizers/
• vercel-directive-strip.mjs · lib/sanitizers/
• window-units.mjs · lib/sanitizers/
• cache-components-suspense-dedupe.mjs · lib/scanners/
• edge-heavy-import.mjs · lib/scanners/
• force-dynamic.mjs · lib/scanners/
• …and 96 more

SKILL.md (first lines)

# Vercel Optimize

Run an observability-first Vercel optimization audit.
Do not inspect source files until `signals.json` exists and a deterministic gate points
to a route, file, or project setting.

Core doctrine: read [references/doctrine.md](references/doctrine.md) if any rule is
unclear.

- Metrics first. Recommendations start from Vercel production signals, not repo-wide
  grep.
- Deterministic gates.
  `scripts/gate-investigations.mjs` decides what deserves investigation.
- Candidate-bound scope.
  Read only files named by a candidate or a route-local import chain.
- Version-aware citations.
  Use only `references/docs-library.json`; invalid or version-mismatched citations are
  stripped.
- Customer copy. Read [references/voice.md](references/voice.md) before writing report
  text or chat output.

## Prerequisites

- Vercel CLI v53+ with `vercel metrics`, `vercel usage`, `vercel contract`, and
  `vercel api`.
- Authenticated CLI session: `vercel login`.
- Linked app directory: `vercel link`. `VERCEL_PROJECT_ID` can help resolve project
  config, but `vercel metrics` still requires directory linkage.
  The link or environment must include the intended project org/team/user scope so the
  collector can resolve a CLI-safe `--scope` and keep `vercel metrics`, `vercel usage`,
  and `vercel contract` on the same account.
- Node.js 20+.
- Observability Plus for route-level metric-backed recommendations.

Never put auth tokens in shell commands.
Do not type `VERCEL_TOKEN=...`, `--token ...`, or `Authorization: Bearer ...` into
commands that may be echoed in chat.

## Framework Support

The preflight reads `package.json` and sets expectations before metric fan-out.

| Framework | Status | Notes |
| --- | --- | --- |
| Next.js App Router | supported | strongest route mapping, scanners, playbooks, citations |
| Next.js Pages Router | supported | scoped to Pages Router idioms when detected |
| SvelteKit | supported | route mapping for `src/routes` files and SvelteKit scanner |
| Nuxt | supported | route mapping plus generic/platform checks; fewer framework-specific recs |
| Astro | limited | route mapping plus generic checks; fewer framework-specific recs |
| Hono / Remix / unknown | blocked by default | continue only if the user accepts a limited platform/code-only audit |

If unsupported, stop and ask before scanning or gating:

```text
This project uses <framework>. Vercel Optimize supports metric-backed code recommendations for Next.js, SvelteKit, and Nuxt. Astro support is limited. For <framework>, I can still run a limited platform/scanner audit, but route-level Vercel metrics may not map back to source files.

Do you want me to continue with the limited audit, or stop here?
```

If the user continues, rerun collection with `--continue-unsupported-framework`.

## Run Directory

Use a fresh run directory for every audit.
Do not reuse briefs, sub-agent outputs, or reports across runs.

```bash
RUN_DIR="$(mktemp -d -t vercel-optimize-XXXXXX)"
```

## Pipeline

### 1. Collect, scan, and merge signals

Run from the linked app directory or pass `--cwd` where a script supports it.
Keep stdout JSON separate from stderr logs.
Do not combine streams.

```bash
node scripts/collect-signals.mjs [projectId] > "$RUN_DIR/vercel-signals.json" 2> "$RUN_DIR/collect.stderr"
node -e 'JSON.parse(require("fs").readFileSync(process.argv[1], "utf8"))' "$RUN_DIR/vercel-signals.json"

node scripts/scan-codebase.mjs <repo-root> > "$RUN_DIR/codebase.json"
node scripts/merge-signals.mjs "$RUN_DIR/vercel-signals.json" "$RUN_DIR/codebase.json" --out "$RUN_DIR/signals.json"
```

Collection details, schemas, metric IDs, and degradation behavior live in
[references/data-collection.md](references/data-collection.md).
The metric registry is [lib/queries.mjs](lib/queries.mjs); keep all queries on the
shared 14-day window.

`collect-signals.mjs` resolves the linked project owner to `commandScope.cliScope` and
verifies that the resolved account can read the resolved project before it checks
Observability Plus.
Downstream scripts reuse that scope for every Vercel CLI command that
accepts `--scope`. Do not run `vercel usage`, `vercel metrics`, or `vercel contract`
manually without the same scope; unscoped usage can report the user’s personal
organization while route metrics come from the team project.

If project or scope resolution is ambiguous, stop and ask the user which Vercel project
and team/personal scope they want audited.
Do not infer the intended scope from the current `vercel whoami` team, and do not
proceed with metrics, usage, or contract collection until the link, an exact project
match in `.vercel/repo.json`, or `VERCEL_PROJECT_ID` + `VERCEL_ORG_ID` identifies the
intended account.

Use this prompt for `PROJECT_SCOPE_UNRESOLVED`, `SCOPE_UNRESOLVED`, or
`PROJECT_SCOPE_MISMATCH`:

```text
I can't safely identify the Vercel project and account for this audit yet.

Please confirm the Vercel project name or ID and the team slug/name, or tell me it's under your personal account. Once confirmed, I'll relink or rerun collection against that exact scope before checking metrics.
```

### 1.1 Stop on blockers

Check blockers before gating:

```bash

From dotlas/skills, MIT.

More from dotlas/skills