CLI Overview

The vk CLI is your primary tool for working with VentureKit projects.

Installation

npm install -g @venturekit/cli@dev

Commands

Command	Alias	Description
vk init		Scaffold a new project from a template
vk dev		Start local development server
vk deploy		Deploy to AWS
vk remove		Tear down deployed resources
vk generate	vk g	Generate routes and configs
vk open		Open local dev tools (db, storage, queues, crons)
vk migrate		Apply pending pure-SQL migrations
vk logs		Tail CloudWatch logs for deployed functions
vk status		Show deployed resources and health

Global Options

Option	Description
--help	Show help for any command
--version	Show CLI version

Getting Started

# 1. Create a project
vk init my-app

# 2. Enter the project
cd my-app && npm install

# 3. Start development
vk dev

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

# 5. Deploy
vk deploy --stage prod