Skip to content

vk deploy

Terminal window
vk deploy [options]
OptionDescriptionDefault
-s, --stage <stage>Stage name (dev, stage, prod)dev

Deploys your VentureKit application to AWS via CDK. The stage determines which environment config is used:

StageConfig FileTypical Preset
devconfig/dev.tsnano
stageconfig/stage.tsmicro
prodconfig/prod.tsmedium or large
Terminal window
# Deploy dev (default)
vk deploy
# Deploy staging
vk deploy --stage stage
# Deploy production
vk deploy --stage prod

When deploying to prod or production, the CLI displays a warning:

⚠️ Production deployment - please verify your changes

After a successful deployment, the CLI shows:

  • The deployed stage name
  • The API Gateway URL (if available)
✅ Deployed to prod
API URL: https://abc123.execute-api.eu-west-1.amazonaws.com
  1. Loads your vk.config.ts and resolves the environment config for the stage
  2. Generates a CDK app in .vk/cdk/ with a VentureStack
  3. Runs cdk deploy to synthesize and deploy CloudFormation stacks
  4. Creates or updates Lambda functions, API Gateway, and all declared infrastructure