Skip to content

@venturekit/cli

Installation

# Global install
npm install -g @venturekit/cli

# Or as a project dependency
npm install @venturekit/cli

Commands

Command	Description
`vk init`	Scaffold a new project
`vk dev`	Start development server
`vk check`	Type-check the project (`tsc --noEmit`) without deploying
`vk doctor`	Diagnose toolchain, `vk.config.ts`, package versions, environment and AWS access
`vk deploy`	Deploy to AWS
`vk remove`	Tear down resources
`vk generate`	Generate routes, configs, OpenAPI, clients, Postman collections, E2E scaffolding
`vk migrate`	Database migrations
`vk logs`	Tail CloudWatch logs
`vk status`	Deployed resources and health
`vk open`	Local dev tools (db, storage, queues, crons, users)
`vk cert`	Request ACM certificates for custom domains
`vk gha`	GitHub Actions OIDC role + deploy/E2E workflows
`vk review`	Prepare an AI-driven branch review in the IDE agent

Quick Reference

# Create a new project
vk init my-app --template api

# Start development
vk dev

# Generate a route
vk g route tasks -m post --scopes tasks.write

# Type-check, check deploy readiness, then deploy to production
vk check
vk doctor --stage prod
vk deploy --stage prod

# Run migrations
vk migrate
vk migrate status

# CI plumbing
vk gha bootstrap && vk gha workflow

vk --version reports the installed package version, including @dev-stamped builds.

Dependencies

@venturekit/core — configuration types
commander — CLI framework
chalk — terminal colors
ora — spinners
prompts — interactive prompts

Quickstart — create your first project
CLI Reference — full command documentation
Deployment — deployment guide