Documentation
Comprehensive guide to using create-vlang-app
Introduction to create-vlang-app
create-vlang-app is a powerful command-line tool designed to streamline the process of setting up modern V applications. It provides a collection of carefully crafted templates and extensions that help developers quickly bootstrap projects with best practices and optimal configurations.
All generated projects now include a curated AGENTS.md file (powered by agents.md) that scopes how AI coding assistants (Cursor, GitHub Copilot Chat, PR bots) should interact with the repository. This keeps human documentation clean while giving AI precise operating guidelines.
Key Benefits
- Rapid Setup
Bootstrap projects in seconds with a single command
- Curated Templates
Choose from a variety of specialized project templates
- Modular Extensions
Add only the features you need with optional extensions
- Customizable
Tailor templates to your specific requirements
Getting Started
Using create-vlang-app is straightforward. You can create a new project with a single command:
v install create-vlang-appThis will launch an interactive CLI that guides you through selecting a template and optional extensions for your project.
Prerequisites
Before using create-vlang-app, ensure you have the following installed:
- V compiler 0.5 or later (
v version) - git (for repository initialization after scaffolding)
Command Options
The CLI supports several options to customize your project creation:
| Option | Description |
|---|---|
-V, --version | Output the version number |
-v, --verbose | Print additional logs |
-i, --info | Print environment debug info |
--no-install | Generate project without running v install |
-t, --template <template> | Specify a template from cva-templates |
--addons [extensions...] | Specify extensions to merge into the scaffold |
--extend [extensions...] | Alias for --addons |
-f, --force | Overwrite an existing non-empty directory |
--interactive | Run prompts to select template and extensions |
--no-cache | Bypass catalog cache (~/.cache/cva) |
--list-templates | List all available templates |
--list-addons | List all available addons |
-h, --help | Display help for command |
Examples
Create a project with interactive mode:
create-vlang-app my-app --interactiveCreate a project with a specific template:
create-vlang-app my-app --template web-server --addons v-docker github-setupCreate a project with a template and extensions:
create-vlang-app my-app --template web-server --addons v-docker github-setupList all available templates:
create-vlang-app --list-templatesList all available extensions:
create-vlang-app --list-addonsAvailable Templates
create-vlang-app offers a variety of templates for different types of applications:
Wave-1 V templates
Web servers, CLIs, libraries, and systems apps from cva-templates.