Skip to content

CLI Overview

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

Terminal window
npm install -g @venturekit/cli@dev
CommandAliasDescription
vk initScaffold a new project from a template
vk devStart local development server
vk deployDeploy to AWS
vk removeTear down deployed resources
vk generatevk gGenerate routes and configs
vk migrateDatabase migrations (Drizzle Kit)
OptionDescription
--helpShow help for any command
--versionShow CLI version
Terminal window
# 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