package
Helpers for locating and executing the Vercel CLI
npm install @vercel/cli-execGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
@vercel/cli-execHelpers for locating and executing the Vercel CLI from other Node packages.
findVercelCli(options?)Asynchronously resolves the Vercel CLI executable without running it.
Returns a Promise<VercelCliInvocation | null>.
node_modules/.bin/vercelPATHnull when no usable CLI installation is foundexecVercelCli(args, options?)Resolves and runs the Vercel CLI, returning:
stdoutstderrinvocationIt preserves access to local node_modules/.bin entries and Node itself even
when the caller passes a sanitized PATH.
clearVercelCliLookupCache()Clears cached CLI lookups. Use this when a long-lived process needs to pick up an install or uninstall that happened after an earlier resolution attempt.
VercelCliErrorThrown when resolution or execution fails. The code field is one of:
VERCEL_CLI_INVALID_CWDVERCEL_CLI_NOT_FOUNDVERCEL_CLI_PERMISSION_DENIEDVERCEL_CLI_ERROREDVERCEL_CLI_TIMED_OUTVERCEL_CLI_CANCELEDVERCEL_CLI_SIGNALEDVERCEL_CLI_EXEC_FAILEDAvailable fields:
message: human-readable error messagecode: stable machine-readable error codeinvocation: resolved CLI command metadata when a command was selectedstdout: captured standard output when the child process produced outputstderr: captured standard error when the child process produced outputexitCode: numeric exit code for non-zero process exitscause: original underlying error when availablematt.straka
matt.j.straka@gmail.com
Estimated unpacked size across 18 packages.
835.6 kB
Includes dependencies.