Skip to content

@venturekit/cli

Installation

# Global install
npm install -g @venturekit/cli@dev

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

Commands

Command	Description
`vk init`	Scaffold a new project
`vk dev`	Start development server
`vk deploy`	Deploy to AWS
`vk remove`	Tear down resources
`vk generate`	Generate routes and configs
`vk migrate`	Database migrations

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

# Deploy to production
vk deploy --stage prod

# Run migrations
vk migrate generate
vk migrate up

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