vk check

Usage

vk check [options]

vk check runs the TypeScript compiler in no-emit mode against the project’s tsconfig.json. It is the same gate vk deploy runs before touching AWS, exposed as a standalone command for fast local and CI feedback — catching type errors in routes, functions and vk.config.ts before a half-applied CloudFormation deploy has to be unwound.

Options

Option	Description	Default
-p, --project <tsconfig>	Path to a specific tsconfig.json	nearest tsconfig.json in the project root

Behaviour

• Exit code mirrors tsc: 0 on success, 1 on type errors.
• When no tsconfig.json is found and none was requested, the command prints a warning and exits 0 — nothing to check is not a failure. With an explicit --project that cannot be found it exits 1.
• Compiler output is printed verbatim under the spinner on failure.

Examples

# Type-check the current project
vk check

# Use a dedicated build config
vk check --project tsconfig.build.json

# CI — fail fast before the deploy job
- run: pnpm exec vk check

Related

• vk deploy — runs the same check automatically; --skip-typecheck bypasses it