feat(cli): improve api ls command with grouped output and separate help#14720
Merged
feat(cli): improve api ls command with grouped output and separate help#14720
Conversation
- Add colored HTTP method output (GET=cyan, POST=green, PUT=yellow, PATCH=blue, DELETE=red)
- Group endpoints by path with methods listed underneath for condensed view
- Separate help for `api` and `api ls` subcommands
- Move --format option to ls subcommand only (not shown in main api help)
- Add listSubcommand with proper subcommand structure following env command pattern
Before:
METHOD PATH SUMMARY
GET /v1/projects List projects
POST /v1/projects Create a project
After:
/v1/projects
GET List projects
POST Create a project
152 routes, 225 endpoints
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
🦋 Changeset detectedLatest commit: e79a5da The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
Contributor
📦 CLI Tarball ReadyThe Vercel CLI tarball for this PR is now available! Quick TestYou can test this PR's CLI directly by running: npx https://vercel-lkmkjti0n.vercel.sh/tarballs/vercel.tgz --helpUse in vercel.jsonTo use this CLI version in your project builds, add to your {
"build": {
"env": {
"VERCEL_CLI_VERSION": "vercel@https://vercel-lkmkjti0n.vercel.sh/tarballs/vercel.tgz"
}
}
} |
Contributor
🧪 Unit Test StrategyComparing: Strategy: Affected packages only ✅ Only testing packages that have been modified or depend on modified packages. Affected packages - 2 (5%)
Unaffected packages - 39 (95%)
Results
This comment is automatically generated based on the affected testing strategy |
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
jeffsee55
approved these changes
Jan 24, 2026
Merged
ecklf
pushed a commit
that referenced
this pull request
Jan 26, 2026
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@50.5.1 ### Patch Changes - Mild refactor of compile-vercel-config ([#14707](#14707)) - Throw explicit error when vercel.ts routes compilation creates a conflict ([#14709](#14709)) - vercel.ts: normalize items in `routes` array to routes format ([#14705](#14705)) - Improvements to vercel api command. Better ls, and help output ([#14720](#14720)) - Updated dependencies \[[`e0e7e3cdd180eb1e07e2ebaba809a2486b546b5d`](e0e7e3c)]: - @vercel/rust@1.0.5 ## @vercel/config@0.0.27 ### Patch Changes - Remove references to nonexistent `redirects` property ([#14708](#14708)) ## @vercel/rust@1.0.5 ### Patch Changes - Do not allow production prebuilt deployments on Windows ([#14724](#14724)) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Improves the
vercel api lscommand output and help system:GET- cyanPOST- greenPUT- yellowPATCH- blueDELETE- redvercel api --helpandvercel api ls --helpnow show appropriate options for each command--formatto ls subcommand: The--formatoption is only relevant to thelssubcommand and is no longer shown in the mainapihelpBefore
After
Test plan
vercel api lsand verify grouped output with colorsvercel api ls --format jsonand verify JSON output worksvercel api --helpand verify--formatis NOT listedvercel api ls --helpand verify--formatIS listed--refreshflag works for both commands🤖 Generated with Claude Code