Skip to content

Configuration

Primary configuration file for VCL projects.

[project]
name = "my-project"
version = "0.1.0"
dependencies = [
"fastapi>=0.68.0",
"uvicorn>=0.15.0",
]
[project.optional-dependencies]
dev = [
"pytest>=6.0.0",
"black>=21.0.0",
]
[tool.vcl]
python-version = "3.12"
template = "api"

User-specific configuration file.

default_template: api
python_version: 3.12
git_init: true
cache_dir: ~/.vcl/cache

Create custom project templates:

templates/
├── my-template/
│ ├── template.yaml
│ ├── {{project_name}}/
│ │ ├── __init__.py
│ │ └── main.py
│ └── README.md
name: my-template
description: Custom project template
variables:
project_name:
type: string
description: Name of the project
python_version:
type: string
default: "3.12"
  • VCL_HOME - VCL installation directory
  • VCL_CACHE_DIR - Cache directory location
  • VCL_TEMPLATE_PATH - Custom template directory
  • VCL_CONFIG - Custom config file location
  • Document all configuration options
  • Add template development guide
  • Include advanced configuration examples
  • Document CI/CD integration
  • Add migration guide for configuration changes