feat(cli): add project checks command (public API parity) by brookemosby · Pull Request #15816 · vercel/vercel

brookemosby · 2026-04-01T21:16:24Z

Summary

vercel project checks [name] lists checks via public GET /v2/projects/{projectIdOrName}/checks.
Optional --blocks filter with the same enum as the API: build-start, deployment-start, deployment-alias, deployment-promotion, none.
Default table output; --format json prints the API payload. Telemetry + unit tests.

Test plan

pnpm --dir packages/cli run vitest-run test/unit/commands/project/checks.test.ts test/unit/commands/project/index.test.ts

Made with Cursor

- project checks [name] -> GET /v2/projects/{id}/checks - Optional --blocks filter (public enum from checks v2) - Table or --format json; telemetry + unit tests Made-with: Cursor

changeset-bot · 2026-04-01T21:16:39Z

🦋 Changeset detected

Latest commit: fe09516

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 · 2026-04-01T21:18:41Z

Low Risk — New CLI subcommand with input validation, telemetry, and comprehensive unit tests.

.changeset/cli-project-checks.md: minor changeset for new vercel project checks command
checks.ts, checks-add.ts, checks-remove.ts: new CLI subcommands for listing/adding/removing deployment checks
checks.test.ts: unit tests covering list, add, remove, flags, and non-interactive JSON output

^{Assessed at ae1a1c3.}

github-actions · 2026-04-01T21:19:28Z

📦 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-ij5s9hha9.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-ij5s9hha9.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-ij5s9hha9.vercel.sh/tarballs/vercel_runtime-0.13.0.dev1775512973+fe09516-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-ij5s9hha9.vercel.sh/tarballs/vercel_workers-0.1.0.dev1775512973+fe09516-py3-none-any.whl"

github-actions · 2026-04-01T21:19:30Z

🧪 Unit Test Strategy

Comparing: 9f2ec51 → fe09516 (view diff)

Strategy: Affected packages only

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

Affected packages - 1 (3%)

vercel

Unaffected packages - 39 (98%)

@vercel-internals/get-package-json
@vercel/backends
@vercel/build-utils
@vercel/cervel
@vercel/cli-auth
@vercel/client
@vercel/config
@vercel/detect-agent
@vercel/edge
@vercel/elysia
@vercel/error-utils
@vercel/express
@vercel/fastify
@vercel/firewall
@vercel/frameworks
@vercel/fs-detectors
@vercel/functions
@vercel/gatsby-plugin-vercel-builder
@vercel/go
@vercel/h3
@vercel/hono
@vercel/hydrogen
@vercel/koa
@vercel/nestjs
@vercel/next
@vercel/node
@vercel/oidc
@vercel/oidc-aws-credentials-provider
@vercel/python
@vercel/python-analysis
@vercel/redwood
@vercel/related-projects
@vercel/remix-builder
@vercel/routing-utils
@vercel/ruby
@vercel/rust
@vercel/static-build
@vercel/static-config
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

Resolve conflicts: keep project checks subcommand alongside main's access-summary, members, access-groups, web-analytics, speed-insights. Made-with: Cursor

Made-with: Cursor

- Add `project checks add` (POST /v2/projects/.../checks) with --file and flags - Add `project checks remove` / `rm` (DELETE .../checks/{checkId}) - Non-interactive: outputAgentError for validation, ok payloads with next/hint, exitWithNonInteractiveError for API/link failures (variant checks) - List: default JSON + structured success when non-interactive; forReadOnlyCommand - Telemetry: checks add / checks remove; unit tests including NI cases Made-with: Cursor

vercel

Additional Suggestion:

Missing return after writeAgentErrorPayloadAndExit in the isAPIError branch causes fall-through to the unconditional error handler, potentially writing two JSON payloads to stdout.

- Use JSONObject/JSONValue for checks-add request body (matches Client.fetch) - Drop redundant json: true on POST; JSONObject bodies are stringified by client - Type create response as JSONObject so id is a valid JSONValue key - Extend ProjectChecksResponse with optional PaginationOptions - Add unit test asserting pagination is forwarded in --non-interactive JSON Made-with: Cursor

Made-with: Cursor

removeEmoji() used trimStart() on the full string, which removed the intentional leading newline from multiline help output when NO_COLOR disabled chalk and output.print ran removeEmoji. Add unit tests for removeEmoji behavior. Made-with: Cursor

This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @vercel/build-utils@13.13.0 ### Minor Changes - Extend `finalizeLambda` with pluggable ZIP strategy (`createZip`), pre-digest validation hook (`validateZip`), and optional trace tags. Widen `getLambdaEnvironment` buffer param to `{ byteLength: number }`. ([#15856](#15856)) ## vercel@50.41.0 ### Minor Changes - Add `vercel edge-config` with `list`, `add`, `get`, `update`, `remove`, `items`, and `tokens` subcommands for Edge Config dashboard API parity. ([#15822](#15822)) - Add `vercel project checks` to list a project's deployment checks configuration (parity with dashboard), including `--format json` and non-interactive error payloads. ([#15816](#15816)) ### Patch Changes - Improve `vercel teams request` in non-interactive mode: validation, missing team scope, and API errors emit structured JSON on stdout with stable `reason` values and `next[]` commands that preserve global flags (for example `--cwd` and `--non-interactive`). ([#15815](#15815)) - Hide `--search` flag from `vc logs --help` output while continuing to accept it, and update the `--query` flag description to indicate advanced querying with filter syntax support. ([#15854](#15854)) - Updated dependencies \[[`a80217a9ed60d7b7f3e98537b0468cc5488078c1`](a80217a)]: - @vercel/build-utils@13.13.0 - @vercel/backends@0.0.56 - @vercel/elysia@0.1.59 - @vercel/express@0.1.69 - @vercel/fastify@0.1.62 - @vercel/go@3.4.7 - @vercel/h3@0.1.68 - @vercel/hono@0.2.62 - @vercel/hydrogen@1.3.6 - @vercel/koa@0.1.42 - @vercel/nestjs@0.2.63 - @vercel/next@4.16.5 - @vercel/node@5.7.1 - @vercel/python@6.29.0 - @vercel/redwood@2.4.12 - @vercel/remix-builder@5.7.2 - @vercel/ruby@2.3.2 - @vercel/rust@1.0.6 - @vercel/static-build@2.9.9 ## @vercel/backends@0.0.56 ### Patch Changes - Updated dependencies \[[`a80217a9ed60d7b7f3e98537b0468cc5488078c1`](a80217a)]: - @vercel/build-utils@13.13.0 ## @vercel/cervel@0.0.43 ### Patch Changes - Updated dependencies \[]: - @vercel/backends@0.0.56 ## @vercel/client@17.2.68 ### Patch Changes - Updated dependencies \[[`a80217a9ed60d7b7f3e98537b0468cc5488078c1`](a80217a)]: - @vercel/build-utils@13.13.0 ## @vercel/elysia@0.1.59 ### Patch Changes - Updated dependencies \[]: - @vercel/node@5.7.1 ## @vercel/express@0.1.69 ### Patch Changes - Updated dependencies \[]: - @vercel/node@5.7.1 - @vercel/cervel@0.0.43 ## @vercel/fastify@0.1.62 ### Patch Changes - Updated dependencies \[]: - @vercel/node@5.7.1 ## @vercel/fs-detectors@5.14.3 ### Patch Changes - Updated dependencies \[[`a80217a9ed60d7b7f3e98537b0468cc5488078c1`](a80217a)]: - @vercel/build-utils@13.13.0 ## @vercel/gatsby-plugin-vercel-builder@2.1.9 ### Patch Changes - Updated dependencies \[[`a80217a9ed60d7b7f3e98537b0468cc5488078c1`](a80217a)]: - @vercel/build-utils@13.13.0 ## @vercel/h3@0.1.68 ### Patch Changes - Updated dependencies \[]: - @vercel/node@5.7.1 ## @vercel/hono@0.2.62 ### Patch Changes - Updated dependencies \[]: - @vercel/node@5.7.1 ## @vercel/koa@0.1.42 ### Patch Changes - Updated dependencies \[]: - @vercel/node@5.7.1 ## @vercel/nestjs@0.2.63 ### Patch Changes - Updated dependencies \[]: - @vercel/node@5.7.1 ## @vercel/node@5.7.1 ### Patch Changes - Updated dependencies \[[`a80217a9ed60d7b7f3e98537b0468cc5488078c1`](a80217a)]: - @vercel/build-utils@13.13.0 ## @vercel/static-build@2.9.9 ### Patch Changes - Updated dependencies \[]: - @vercel/gatsby-plugin-vercel-builder@2.1.9 Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

## Summary - `vercel project checks [name]` lists checks via public `GET /v2/projects/{projectIdOrName}/checks`. - Optional `--blocks` filter with the same enum as the API: `build-start`, `deployment-start`, `deployment-alias`, `deployment-promotion`, `none`. - Default table output; `--format json` prints the API payload. Telemetry + unit tests. ## Test plan - [x] `pnpm --dir packages/cli run vitest-run test/unit/commands/project/checks.test.ts test/unit/commands/project/index.test.ts` Made with [Cursor](https://cursor.com)

This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @vercel/build-utils@13.13.0 ### Minor Changes - Extend `finalizeLambda` with pluggable ZIP strategy (`createZip`), pre-digest validation hook (`validateZip`), and optional trace tags. Widen `getLambdaEnvironment` buffer param to `{ byteLength: number }`. ([#15856](#15856)) ## vercel@50.41.0 ### Minor Changes - Add `vercel edge-config` with `list`, `add`, `get`, `update`, `remove`, `items`, and `tokens` subcommands for Edge Config dashboard API parity. ([#15822](#15822)) - Add `vercel project checks` to list a project's deployment checks configuration (parity with dashboard), including `--format json` and non-interactive error payloads. ([#15816](#15816)) ### Patch Changes - Improve `vercel teams request` in non-interactive mode: validation, missing team scope, and API errors emit structured JSON on stdout with stable `reason` values and `next[]` commands that preserve global flags (for example `--cwd` and `--non-interactive`). ([#15815](#15815)) - Hide `--search` flag from `vc logs --help` output while continuing to accept it, and update the `--query` flag description to indicate advanced querying with filter syntax support. ([#15854](#15854)) - Updated dependencies \[[`a80217a9ed60d7b7f3e98537b0468cc5488078c1`](a80217a)]: - @vercel/build-utils@13.13.0 - @vercel/backends@0.0.56 - @vercel/elysia@0.1.59 - @vercel/express@0.1.69 - @vercel/fastify@0.1.62 - @vercel/go@3.4.7 - @vercel/h3@0.1.68 - @vercel/hono@0.2.62 - @vercel/hydrogen@1.3.6 - @vercel/koa@0.1.42 - @vercel/nestjs@0.2.63 - @vercel/next@4.16.5 - @vercel/node@5.7.1 - @vercel/python@6.29.0 - @vercel/redwood@2.4.12 - @vercel/remix-builder@5.7.2 - @vercel/ruby@2.3.2 - @vercel/rust@1.0.6 - @vercel/static-build@2.9.9 ## @vercel/backends@0.0.56 ### Patch Changes - Updated dependencies \[[`a80217a9ed60d7b7f3e98537b0468cc5488078c1`](a80217a)]: - @vercel/build-utils@13.13.0 ## @vercel/cervel@0.0.43 ### Patch Changes - Updated dependencies \[]: - @vercel/backends@0.0.56 ## @vercel/client@17.2.68 ### Patch Changes - Updated dependencies \[[`a80217a9ed60d7b7f3e98537b0468cc5488078c1`](a80217a)]: - @vercel/build-utils@13.13.0 ## @vercel/elysia@0.1.59 ### Patch Changes - Updated dependencies \[]: - @vercel/node@5.7.1 ## @vercel/express@0.1.69 ### Patch Changes - Updated dependencies \[]: - @vercel/node@5.7.1 - @vercel/cervel@0.0.43 ## @vercel/fastify@0.1.62 ### Patch Changes - Updated dependencies \[]: - @vercel/node@5.7.1 ## @vercel/fs-detectors@5.14.3 ### Patch Changes - Updated dependencies \[[`a80217a9ed60d7b7f3e98537b0468cc5488078c1`](a80217a)]: - @vercel/build-utils@13.13.0 ## @vercel/gatsby-plugin-vercel-builder@2.1.9 ### Patch Changes - Updated dependencies \[[`a80217a9ed60d7b7f3e98537b0468cc5488078c1`](a80217a)]: - @vercel/build-utils@13.13.0 ## @vercel/h3@0.1.68 ### Patch Changes - Updated dependencies \[]: - @vercel/node@5.7.1 ## @vercel/hono@0.2.62 ### Patch Changes - Updated dependencies \[]: - @vercel/node@5.7.1 ## @vercel/koa@0.1.42 ### Patch Changes - Updated dependencies \[]: - @vercel/node@5.7.1 ## @vercel/nestjs@0.2.63 ### Patch Changes - Updated dependencies \[]: - @vercel/node@5.7.1 ## @vercel/node@5.7.1 ### Patch Changes - Updated dependencies \[[`a80217a9ed60d7b7f3e98537b0468cc5488078c1`](a80217a)]: - @vercel/build-utils@13.13.0 ## @vercel/static-build@2.9.9 ### Patch Changes - Updated dependencies \[]: - @vercel/gatsby-plugin-vercel-builder@2.1.9 Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

feat(cli): add project checks for checks API parity

37b7f38

- project checks [name] -> GET /v2/projects/{id}/checks - Optional --blocks filter (public enum from checks v2) - Table or --format json; telemetry + unit tests Made-with: Cursor

brookemosby requested review from a team as code owners April 1, 2026 21:16

vercel Bot deployed to Preview April 1, 2026 21:19 View deployment

Merge origin/main into brooke/cli-parity-project-checks

ce7d23c

Resolve conflicts: keep project checks subcommand alongside main's access-summary, members, access-groups, web-analytics, speed-insights. Made-with: Cursor

vercel Bot deployed to Preview April 6, 2026 17:35 View deployment

chore: add changeset for project checks CLI parity

db66f27

Made-with: Cursor

vercel Bot deployed to Preview April 6, 2026 17:43 View deployment

Merge branch 'main' into brooke/cli-parity-project-checks

7725301

vercel Bot deployed to Preview April 6, 2026 19:20 View deployment

vercel Bot deployed to Preview April 6, 2026 20:08 View deployment

vercel Bot reviewed Apr 6, 2026

View reviewed changes

vercel Bot deployed to Preview April 6, 2026 20:34 View deployment

test(cli): update project help snapshots for checks subcommand

b51f486

Made-with: Cursor

vercel Bot deployed to Preview April 6, 2026 22:01 View deployment

vercel Bot deployed to Preview April 6, 2026 22:04 View deployment

ShayCichocki approved these changes Apr 6, 2026

View reviewed changes

brookemosby merged commit 3048da1 into main Apr 6, 2026
178 checks passed

brookemosby deleted the brooke/cli-parity-project-checks branch April 6, 2026 22:46

vercel-cli-release-bot mentioned this pull request Apr 6, 2026

Version Packages #15842

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(cli): add project checks command (public API parity)#15816

feat(cli): add project checks command (public API parity)#15816
brookemosby merged 8 commits into
mainfrom
brooke/cli-parity-project-checks

brookemosby commented Apr 1, 2026

Uh oh!

changeset-bot Bot commented Apr 1, 2026 •

edited

Loading

Uh oh!

vercel Bot commented Apr 1, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Apr 1, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Apr 1, 2026 •

edited

Loading

Uh oh!

vercel Bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

brookemosby commented Apr 1, 2026

Summary

Test plan

Uh oh!

changeset-bot Bot commented Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

vercel Bot commented Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📦 CLI Tarball Ready

Quick Test

Use in vercel.json

Python Runtime Wheel

Python Workers Wheel

Uh oh!

github-actions Bot commented Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🧪 Unit Test Strategy

Results

Uh oh!

vercel Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

changeset-bot Bot commented Apr 1, 2026 •

edited

Loading

vercel Bot commented Apr 1, 2026 •

edited

Loading

github-actions Bot commented Apr 1, 2026 •

edited

Loading

github-actions Bot commented Apr 1, 2026 •

edited

Loading