vk deploy
vk deploy [options]Options
Section titled “Options”| Option | Description | Default |
|---|---|---|
-s, --stage <stage> | Stage name (dev, stage, prod) | dev |
Description
Section titled “Description”Deploys your VentureKit application to AWS via CDK. The stage determines which environment config is used:
| Stage | Config File | Typical Preset |
|---|---|---|
dev | config/dev.ts | nano |
stage | config/stage.ts | micro |
prod | config/prod.ts | medium or large |
Examples
Section titled “Examples”# Deploy dev (default)vk deploy
# Deploy stagingvk deploy --stage stage
# Deploy productionvk deploy --stage prodProduction Warning
Section titled “Production Warning”When deploying to prod or production, the CLI displays a warning:
⚠️ Production deployment - please verify your changesOutputs
Section titled “Outputs”After a successful deployment, the CLI shows:
- The deployed stage name
- The API Gateway URL (if available)
✅ Deployed to prodAPI URL: https://abc123.execute-api.eu-west-1.amazonaws.comAuto-Bootstrap
Section titled “Auto-Bootstrap”On first deploy, vk deploy automatically sets up the AWS environment (CDK bootstrap). You never need to run cdk bootstrap manually. If the bootstrap stack is missing, VentureKit handles it transparently:
🚀 Deploying to dev...
✔ Infrastructure template ready Setting up AWS environment (first-time setup)...✔ AWS environment ready✔ Deployed successfully!If bootstrap fails, the CLI provides actionable guidance (e.g. missing AWS credentials).
Under the Hood
Section titled “Under the Hood”- Loads your
vk.config.tsand resolves the environment config for the stage - Generates a CDK app in
.vk/cdk/with aVentureStack - Checks if the AWS environment is bootstrapped; if not, runs bootstrap automatically
- Runs
cdk deployto synthesize and deploy CloudFormation stacks - Creates or updates Lambda functions, API Gateway, and all declared infrastructure
All CDK complexity is hidden — you never interact with CDK directly.