CLI Overview
The vk CLI is your primary tool for working with VentureKit projects.
Installation
Section titled “Installation”npm install -g @venturekit/cli@devCommands
Section titled “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 migrate | Database migrations (Drizzle Kit) |
Global Options
Section titled “Global Options”| Option | Description |
|---|---|
--help | Show help for any command |
--version | Show CLI version |
Getting Started
Section titled “Getting Started”# 1. Create a projectvk init my-app
# 2. Enter the projectcd my-app && npm install
# 3. Start developmentvk dev
# 4. Generate a routevk g route tasks -m post --scopes tasks.write
# 5. Deployvk deploy --stage prod